Skip to main content
GET
cURL

Authorizations

X-API-Key
string
header
required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key
string | null
Authorization
string | null

Query Parameters

scope
enum<string>
default:workspace

workspace is the overview, campaigns compares campaigns, campaign is one campaign in detail.

Available options:
workspace,
campaigns,
campaign
campaign_id
string | null

The campaign's id: the id from List or get campaigns. It is also the last part of that page's address in the app. With scope campaign, or the campaign for a view that needs one.

days
integer
default:30
Required range: 1 <= x <= 365
view
enum<string> | null

A single report instead of scope. funnel, outcomes and email_variants (the A/B result of each email step) need campaign_id. top_campaigns, calls, agents, meetings, geo, deliverability, mailboxes, accounts_health, send_cap, ai_spend, ai_decisions, activity_feed, action_queue.

Available options:
funnel,
outcomes,
email_variants,
top_campaigns,
calls,
agents,
meetings,
geo,
deliverability,
mailboxes,
accounts_health,
send_cap,
ai_spend,
ai_decisions,
activity_feed,
action_queue
agent_id
string | null

The voice agent's id: the id from List or get agents. It is also the last part of that page's address in the app. view calls: only this voice agent.

start_date
string | null

With view: inclusive date YYYY-MM-DD, replaces days.

end_date
string | null

With view: inclusive date YYYY-MM-DD.

metric
string | null

view top_campaigns: meetings, sends, replies or connect_rate. view geo: leads, sends, replies or meetings.

window
string | null

view top_campaigns, ai_spend, ai_decisions: 24h, 7d, 30d or 90d. view deliverability: 24h, 7d or 30d.

dimension
string | null

view ai_spend: model or feature.

outcome_type
enum<string> | null

view outcomes: call (default) or reply.

Available options:
call,
reply
limit
integer
default:50

With view: rows to return.

Required range: 1 <= x <= 200
offset
integer
default:0

With view calls: rows to skip.

Required range: x >= 0

Response

Successful Response

kpis
Kpis · object | null

Headline numbers (scope workspace).