Jump to Content
API Reference
v1.0
Log In
API Reference
Search
Log In
v1.0
API Reference
External API Integration - Overview
All
Pages
Start typing to search…
JUMP TO
Spartera API Documentation
API Keys
Get all API keys for a company. Returns masked API keys for security (sk_****1234).
get
Create single API key. Returns the actual sk_ key (only time it's exposed) and api_key_id for future operations.
post
Delete (deactivate) single API key by api_key_id. Uses the api_key_id returned during creation for clean identification. Fixed to use correct primary key lookup.
del
Get single API key by ID. Returns masked API key for security (sk_****1234).
get
Update an existing API key by ID. Can update metadata like name, expiration, rate limits, etc. Cannot update the actual key value (for security).
patch
Explicitly revoke an API key with reason tracking. This is different from delete as it includes revocation metadata.
post
Get usage statistics for a specific API key. Returns usage count, last used date, failed attempts, etc.
get
Alerts
Get a list of all alerts for a specific user
get
POST /companies/{company_id}/users/{user_id}/alerts
post
Get all alerts for a specific asset (by user)
get
Get all alerts for a specific asset
get
Delete single alert by ID
del
Get single alert by ID
get
Update an existing alert by ID
patch
Asset Price History
Get all price history records for a specific asset
get
Create a new price history record for an asset
post
Get the currently active price for an asset
get
Calculate the credit equivalent for a given USD price without saving
post
POST /companies/{company_id}/assets/{asset_id}/prices/discount
post
Delete single price history record by ID
del
Get single price history record by ID
get
Update an existing price history record by ID
patch
Assets
Process (analyze) an asset with dynamic rate limiting applied via decorator.
get
Process (analyze) an asset with dynamic rate limiting applied via decorator.
post
Get all assets for a specific company
get
Create a new asset
post
Search and filter assets with advanced options Query Parameters: q: Search query string category: Filter by category sport: Filter by sport tag sort_by: Sort field (name|recent|popular|trending) limit: Number of results (default 20, max 100) offset: Offset for pagination include_recommended: Include recommendations (true/false) include_schema: Include asset_schema in response (true/false, default false)
get
Get statistics for all assets the user has access to
get
Delete single asset by ID
del
Get single asset by ID
get
Update an existing asset by ID
patch
Get the information schema for a specific asset's table
get
Retrieve and save an asset's information schema
get
Get AI-predicted pricing for a specific asset
get
Scan a column in the asset's table to retrieve distinct values Request Body: column (str): Column name to scan limit (int, optional): Maximum distinct values to return (default 1000, max 5000) Returns: Flask Response with scan results
post
Get statistics for a specific asset (public endpoint)
get
GET /companies/{company_id}/assets/{asset_id}/test
get
POST /companies/{company_id}/assets/{asset_id}/test
post
Cloud Providers
Get a list of all cloud providers
get
Get single cloud provider by ID
get
Companies
Get details of the requestor's own company
get
Update an existing company by ID
patch
Get asset performance analytics. Query params: start_date, end_date, limit, sort_by, include
get
Get customer analytics including growth and segmentation. Query params: start_date, end_date, group_by, segment_by
get
Get comprehensive dashboard analytics for seller dashboard. Query params: start_date, end_date, period (day/week/month/quarter)
get
Get summary metrics (counts only). No date params needed — returns all-time totals. Performance: < 0.1s
get
Get sales over time analytics. Query params: start_date, end_date, group_by (day/week/month/quarter), metrics
get
Get all objects (connections, assets) of a single company
get
Get the total number of requests allocated in the company's current subscription plan.
get
Get company request usage data for a specific month.
get
Creating Data Connections
Get all connections for a specific company
get
Create a new connection by ID
post
Delete single connection by ID
del
Get single connection by ID
get
Update an existing connection by ID
patch
Retrieve the information schema for the specified connection
get
Test the specified connection
get
Favorites
Get a list of all favorites for a specific user
get
POST /companies/{company_id}/users/{user_id}/favorites
post
Get all favorites for the specified user in a specific category
get
Check if the specified user has favorited a specific asset
get
Get all favorites for the specified user that don't have a category
get
Delete single favorite by ID (unfavorite an asset)
del
Get single favorite by ID
get
Update an existing favorite by ID
patch
Job Functions
Get a list of all job functions
get
Get single job function by ID
get
Storage Engines
Get a list of all storage engines
get
Get single storage engine by ID
get
Users
Get a list of all users in a company
get
Create a new user
post
POST /companies/{company_id}/users/google-oauth
post
Logout current user by revoking their sessions
post
Delete single user by ID
del
Get single user by ID
get
Update an existing user by ID
patch
Get current authenticated user's profile.
get
Welcome to Spartera
Platform Overview
Quickstart Guide
Use Cases & Examples
Analytics Platform
Assets Overview
Creating Assets
Supported Data Sources
Publishing to Marketplace
Testing and Validation
AutoInsights
External API Integration - Overview
Requirements & Standards
Response Schema Specification
Credential Formats Reference
Connecting Your API
Function ID Routing
Creating Assets from APIs
Marketplace Platform
Marketplace Overview
Buying Insights
Selling Insights
Pricing Models
Revenue Sharing
Quality Guidelines
Backend Platform Best Practices
Denormalized Tables Best Practices
Picking the Proper Granularity of Records
Raw vs Semantic Layers Architecture
Which Chart Type is Best - Selection Guide
IP Whitelisting
API Overview
Authentication Endpoints
Analytics Endpoints
Marketplace Endpoints
Insights Endpoints
Billing Endpoints
User Management Endpoints
REST API Examples
SDKs & Libraries
Go SDK
Ruby SDK
JavaScript SDK
Python SDK
PHP SDK
Java SDK
FAQ Platform Overview
Data Connections
Creating Assets
Marketplace
Distribution & APIs
Performance & Processing
Getting Help
Legal & Compliance
Terms of Service
Privacy Policy
Security & Compliance
Video Guides
Security & Compliance
Credit System
SparteraConnect
Credential Formats Reference
Security & Compliance
Endpoints
Get all endpoints for a specific company with pagination, filtering, and sorting
get
Create a new endpoint
post
Get schema information for a connection Query parameters: include_fields: Whether to include field information (default: true) schemas: Optional comma-separated schemas to include tables: Optional comma-separated tables to include
get
Delete single endpoint by ID
del
Get single endpoint by ID
get
Update an existing endpoint by ID
patch
GET /companies/{company_id}/endpoints/{endpoint_id}/available-endpoints
get
Execute an endpoint with pagination support. Customer-facing route that returns paginated data. Query params: ?start=0&limit=100
get
GET /companies/{company_id}/endpoints/{endpoint_id}/keys
get
POST /companies/{company_id}/endpoints/{endpoint_id}/keys
post
DELETE /companies/{company_id}/endpoints/{endpoint_id}/keys/{api_key_id}
del
Get usage statistics for an endpoint Query parameters: days: Number of days to analyze (default: 30)
get
Test an endpoint with sample data Request body (optional): limit: Number of sample rows to return (default: 10)
get
GET /companies/{company_id}/endpoints/{endpoint_id}/url
get
Postgen Integrations
Get a list of all postgen integrations for the company. All company users can view integrations.
get
POST /companies/{company_id}/postgen_integrations
post
POST /companies/{company_id}/postgen_integrations/test
post
Delete single integration by ID. Also deletes credentials from GCP Secret Manager.
del
Get single integration by ID.
get
Update an existing integration by ID. Can update credentials, is_active status, etc.
patch
Posts
Get a list of all posts for the user's company. Supports filtering, sorting, pagination.
get
POST /companies/{company_id}/posts
post
GET /companies/{company_id}/posts/summary
get
Delete single post by ID.
del
Get single post by ID.
get
Update an existing post by ID. Note: last_edited_at is automatically updated.
patch
Get all publications for a post. Shows where this post has been published to external platforms. Returns: Array of publication records with platform, URL, status
get
Publish a post (make it publicly visible).
post
Publish a post to an external platform via an integration. Args: post_id: ID of the post to publish integration_id: ID of the integration to use (from postgen_integrations) Returns: Publication record with external_url and external_post_id
post
Unpublish a post (make it private/draft again).
post
Increment view count for a post. Public endpoint (no authentication required).
post
Creating Visualizations
External API Connections
Python Examples
Security & Compliance
Asset Usecases
Get a list of all asset use cases
get
Get single asset use case by ID
get
Industries
Get a list of all industries
get
Get a list of industries that have active marketplace products
get
Get single industry by ID
get
Powered by
Spartera API Documentation
External API Integration - Overview
Ask AI
