EndpointsInput class
Constructors
EndpointsInput ({DateTime ?dateCreated , DateTime ?lastUpdated , String ?userId , required String companyId , required String connectionId , int ?industryId , int ?aucId , EndpointsInputApprovalStatusEnum ?approvalStatus , String ?approvedByUserId , DateTime ?approvedAt , bool ?sellInMarketplace , required String name , String ?slug , String ?description , String ?detailedDescription , String ?topQuestions , String ?sourceSchemaName , String ?sourceTableName , String ?customerName , Object ?endpointSchema , int ?rateLimitNumber , EndpointsInputRateLimitPeriodEnum ?rateLimitPeriod , EndpointsInputRateLimitGranularityEnum ?rateLimitGranularity , EndpointsInputAccessMethodEnum ?accessMethod , Object ?accessWhitelist , EndpointsInputStatusEnum ?status , DateTime ?dataTimePeriodStart , DateTime ?dataTimePeriodEnd , DateTime ?dateCollectionStart , EndpointsInputGeographicCoverageTypeEnum ?geographicCoverageType , String ?geographicCoverageDetails , EndpointsInputDataSourceRefreshFrequencyEnum ?dataSourceRefreshFrequency , String ?tags , DateTime ?lastAccessed , int ?maxRecordsPerRequest , bool ?exportEnabled , int ?maxRecordsPerExport , Object ?sampleResponse , bool ?active
Returns a new EndpointsInput instance.
Properties
accessMethod ↔ EndpointsInputAccessMethodEnum ?
Access control method (OPEN, API_KEY, IP, EMAIL, DOMAIN)
getter/setter pair
accessWhitelist ↔ Object ?
List of allowed IPs, emails, or domains based on access_method. Format: {type: 'ip'|'email'|'domain', values: '192.168.1.1', ...}
getter/setter pair
active ↔ bool ?
Required.
getter/setter pair
approvalStatus ↔ EndpointsInputApprovalStatusEnum ?
Approval status before marketplace publication
getter/setter pair
approvedAt ↔ DateTime ?
Timestamp of marketplace approval
getter/setter pair
approvedByUserId ↔ String ?
User who approved this endpoint for marketplace
getter/setter pair
aucId ↔ int ?
Primary use case for marketplace discovery
getter/setter pair
companyId ↔ String
References companies.company_id — A Spartera seller or buyer company account. See GET /companies for valid values. Required.
getter/setter pair
connectionId ↔ String
Connection to the data source
getter/setter pair
customerName ↔ String ?
Named customer for B2B deals (pricing handled via asset_price_history)
getter/setter pair
dataSourceRefreshFrequency ↔ EndpointsInputDataSourceRefreshFrequencyEnum ?
How often the source data is refreshed
getter/setter pair
dataTimePeriodEnd ↔ DateTime ?
End date of the data time period covered
getter/setter pair
dataTimePeriodStart ↔ DateTime ?
Start date of the data time period covered
getter/setter pair
dateCollectionStart ↔ DateTime ?
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.
getter/setter pair
dateCreated ↔ DateTime ?
Required.
getter/setter pair
description ↔ String ?
Description of what this endpoint provides
getter/setter pair
detailedDescription ↔ String ?
Long-form HTML description for product pages and SEO
getter/setter pair
endpointSchema ↔ 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.
getter/setter pair
exportEnabled ↔ bool ?
Whether this endpoint supports bulk export to GCS. When True, buyers can request delivery=gcs with format=csv|parquet. Independent of max_records_per_request, which only governs inline JSON.
getter/setter pair
geographicCoverageDetails ↔ String ?
Specific regions/countries covered (e.g., 'United States, Canada, Mexico')
getter/setter pair
geographicCoverageType ↔ EndpointsInputGeographicCoverageTypeEnum ?
Type of geographic coverage
getter/setter pair
hashCode → int
The hash code for this object.
no setter override
industryId ↔ int ?
Industry / category for marketplace discovery
getter/setter pair
lastAccessed ↔ DateTime ?
When this endpoint was last called
getter/setter pair
lastUpdated ↔ DateTime ?
Required.
getter/setter pair
maxRecordsPerExport ↔ int ?
Hard ceiling on rows returned per GCS export. Separate from max_records_per_request so sellers can offer larger downloads via file delivery without expanding inline JSON responses.
getter/setter pair
maxRecordsPerRequest ↔ int ?
Seller-enforced row cap per request. Buyers cannot exceed this. Default 1000.
getter/setter pair
name ↔ String
Human-readable name for the endpoint
getter/setter pair
rateLimitGranularity ↔ EndpointsInputRateLimitGranularityEnum ?
How to group rate limits (IP, USER, COMPANY, API_KEY, GLOBAL)
getter/setter pair
rateLimitNumber ↔ int ?
Number of requests allowed per rate_limit_period
getter/setter pair
rateLimitPeriod ↔ EndpointsInputRateLimitPeriodEnum ?
Time period for rate limiting (HOUR, DAY, MONTH)
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setter inherited
sampleResponse ↔ Object ?
Last successful {spartera, request, response} envelope. Saved on each successful marketplace run. Displayed as preview on product page load.
getter/setter pair
sellInMarketplace ↔ bool ?
Whether this endpoint appears in the public marketplace
getter/setter pair
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.
getter/setter pair
sourceSchemaName ↔ String ?
Schema/database name where the table resides
getter/setter pair
sourceTableName ↔ String ?
Table name to query from
getter/setter pair
status ↔ EndpointsInputStatusEnum ?
Current status of the endpoint (ACTIVE, INACTIVE, DEPRECATED)
getter/setter pair
tags ↔ String ?
Comma-separated tags for organizing endpoints
getter/setter pair
topQuestions ↔ 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.
getter/setter pair
userId ↔ String ?
User who created this endpoint
getter/setter pair
