Create a new endpoint

post

https://api.spartera.com/companies/{company_id}/endpoints

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

company_id

string

required

length between 1 and 255

^[a-zA-Z0-9_-]+$

Unique identifier for the Company

Query Params

page

integer

≥ 1

Defaults to 1

Page number for pagination

limit

integer

1 to 100

Defaults to 20

Number of items per page

sort_by

string

Field to sort by

sort_order

string

enum

Defaults to desc

Sort order (ascending or descending)

Allowed:

string

length between 1 and 255

Search term to filter results

Body Params

Input schema for creating Endpoint

date_created

date-time

Required.

last_updated

date-time

Required.

user_id

string

User who created this endpoint

company_id

string

required

References companies.company_id — A Spartera seller or buyer company account. See GET /companies for valid values. Required.

connection_id

string

required

Connection to the data source

industry_id

int64

Industry / category for marketplace discovery

auc_id

int64

Primary use case for marketplace discovery

approval_status

string

enum

Approval status before marketplace publication

Allowed:

approved_by_user_id

string

User who approved this endpoint for marketplace

approved_at

date-time

Timestamp of marketplace approval

sell_in_marketplace

boolean

Whether this endpoint appears in the public marketplace

name

string

required

Human-readable name for the endpoint

slug

string

Human-readable, URL-safe slug derived from name at creation time. e.g. 'NFL Live Moneyline & Spread Odds' → 'nfl-live-moneyline-spread-odds'. Never changes after creation. Unique within company (DB constraint). Creation fails with 409 if a duplicate name exists in the same company.

description

string

Description of what this endpoint provides

detailed_description

string

Long-form HTML description for product pages and SEO

top_questions

string

Top 3 questions this endpoint can help answer, in English. Stored as JSON array of strings (1-3 items, 15-200 chars each). Strongly encouraged for marketplace endpoints but not required — nudge via UI completeness score, not hard validation.

source_schema_name

string

Schema/database name where the table resides

source_table_name

string

Table name to query from

customer_name

string

Named customer for B2B deals (pricing handled via asset_price_history)

endpoint_schema

object

Column configurations including aggregations, filters, and visibility. Format: {columns: [{name, type, aggregation, filter, is_hidden, alias, ...}]}. This is the source of truth — SQL is generated at runtime from this configuration.

rate_limit_number

int64

Number of requests allowed per rate_limit_period

rate_limit_period

string

enum

Time period for rate limiting (HOUR, DAY, MONTH)

Allowed:

rate_limit_granularity

string

enum

How to group rate limits (IP, USER, COMPANY, API_KEY, GLOBAL)

Allowed:

access_method

string

enum

Access control method (OPEN, API_KEY, IP, EMAIL, DOMAIN)

Allowed:

access_whitelist

object

List of allowed IPs, emails, or domains based on access_method. Format: {type: 'ip'|'email'|'domain', values: ['192.168.1.1', ...]}

status

string

enum

Current status of the endpoint (ACTIVE, INACTIVE, DEPRECATED)

Allowed:

data_time_period_start

date-time

Start date of the data time period covered

data_time_period_end

date-time

End date of the data time period covered

date_collection_start

date-time

When the seller began actively collecting this data. Distinct from data_time_period_start, which describes when the records themselves begin. Backfilled historical data will have date_collection_start > data_time_period_start.

geographic_coverage_type

string

enum

Type of geographic coverage

geographic_coverage_details

string

Specific regions/countries covered (e.g., 'United States, Canada, Mexico')

data_source_refresh_frequency

string

enum

How often the source data is refreshed

200Successfully created endpoints

400Invalid input

401Authentication required

403Permission denied

409Resource conflict (duplicate, constraint violation)

422Request well-formed but semantically invalid

429Rate limit exceeded

500Internal server error