Sales Engine
API documentation
Usage and costOperation usage.detail

Get provider usage in detail

Provider usage by tool, model, job type, operation, campaign, list and research run, plus the latest calls.

GET/api/v1/usage
Scope read: Read anything in the workspace.

Parameters

Query

NameInDescription
rangequeryTimeline: 7d, 30d, 90d or custom. One of 7d, 30d, 90d, custom.
fromqueryCustom start date, YYYY-MM-DD.
toqueryCustom end date, YYYY-MM-DD.
providerqueryOnly this provider.
campaign_idqueryOnly this campaign.

Example

curl
curl -X GET "https://crm.ashwanth.dev/api/v1/usage" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY"
CLI
sales-engine usage detail

Response

A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.

Shape
{
  "data": { ... }
}

Run it below to see the live shape for your workspace.

Try it

Runs against this server, as the workspace behind the key.
Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.
Query
Timeline: 7d, 30d, 90d or custom.
Custom start date, YYYY-MM-DD.
Custom end date, YYYY-MM-DD.
Only this provider.
Only this campaign.
Request
GET /api/v1/usage

Also in Usage and cost