Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.0
API Reference
Get details of the requestor's own company
Search
JUMP TO
Spartera API Documentation
API Keys
Get all API keys
get
Create single API key
post
Get single API key by ID
get
Update an existing API key by ID
patch
Delete single API key by token
delete
Cloud Providers
Get a list of all cloud providers
get
Get single cloud provider by ID
get
Favorites
Get a list of all favorites for a specific user
get
POST /companies/{company_id}/users/{user_id}/favorites
post
Get single favorite by ID
get
Update an existing favorite by ID
patch
Delete single favorite by ID (unfavorite an asset)
delete
Get all favorites for the specified user in a specific category
get
Get all favorites for the specified user that don't have a category
get
Check if the specified user has favorited a specific asset
get
Asset Price History
Get all price history records for a specific asset
get
Create a new price history record for an asset
post
Get single price history record by ID
get
Update an existing price history record by ID
patch
Delete single price history record by ID
delete
Get the currently active price for an asset
get
POST /companies/{company_id}/assets/{asset_id}/prices/discount
post
POST /companies/{company_id}/assets/{asset_id}/prices/calculate_credits
post
Storage Engines
Get a list of all storage engines
get
Get single storage engine by ID
get
Alerts
Get a list of all alerts for a specific user
get
POST /companies/{company_id}/users/{user_id}/alerts
post
Get single alert by ID
get
Update an existing alert by ID
patch
Delete single alert by ID
delete
Get all alerts for a specific asset (by user)
get
Get all alerts for a specific asset
get
Connections
Get all connections for a specific company
get
Create a new connection by ID
post
Get single connection by ID
get
Update an existing connection by ID
patch
Delete single connection by ID
delete
Retrieve the information schema for the specified connection
get
Test the specified connection
get
Users
Get a list of all users in a company
get
Create a new user
post
Get single user by ID
get
Update an existing user by ID
patch
Delete single user by ID
delete
Get current authenticated user's profile information. Returns: JSON response with user profile data from database
get
Assets
Get all assets for a specific company
get
Create a new asset
post
Get single asset by ID
get
Update an existing asset by ID
patch
Delete single asset by ID
delete
Get the information schema for a specific asset's table
get
Test out an Asset (on a subset of data)
get
Retrieve and save an asset's information schema
get
Get statistics for all assets the user has access to
get
Get AI-predicted pricing for a specific asset
get
Get statistics for a specific asset (public endpoint)
get
Process (analyze) an asset. Attempt to process an analytic on a backend warehouse/AI model.
get
Companies
Get details of the requestor's own company
get
Update an existing company by ID
patch
Get the total number of requests allocated in the company's current subscription plan.
get
Get company request usage data for a specific month. Returns JSON metrics by default or CSV logs when download parameter is included.
get
Get all objects (connections, assets) of a single company
get
Get comprehensive dashboard analytics for seller dashboard Includes all metrics needed for dashboard charts in one call Query params: start_date, end_date, period (day/week/month/quarter)
get
Get sales over time analytics Query params: start_date, end_date, group_by (day/week/month/quarter), metrics
get
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
Powered by
Get details of the requestor's own company
get
https://api.spartera.com/companies/
{company_id}
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
URL
Base URL
https://api.spartera.com
/companies/{company_id}
RESPONSE
Click
Try It!
to start a request and see the response here!
