Skip to main content
GET
Export safe daily post metric history in bulk

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

FlowAuthorization Code
Authorization URL
https://app.sideshift.app/api/oauth/v1/authorize
Token URL
https://app.sideshift.app/api/oauth/v1/token
Refresh URL
https://app.sideshift.app/api/oauth/v1/token
Scopes1
analytics:read
Read analytics and performance data.

Headers

X-Act-As-Company
string

OAuth human grants can select one of the companies explicitly connected at consent. The target's grant, live user permissions, and subscription are checked independently. OAuth human grants and scoped Platform API keys can also act on one direct agency sub-account included in their explicit delegation. Current parent relationship, authorizing person access, child scope ceiling, and subscription eligibility are checked. Omit this header to act on the connected company. Machine client_credentials tokens do not carry delegation. Query parameters such as companyId, company_id, client, and subaccountId are not general tenant selectors where an endpoint does not explicitly document them.

Query Parameters

fromDate
string<date>
required

First observed metric date, inclusive.

toDate
string<date>
required

Last observed metric date, inclusive. The range may span at most 366 days.

programId
string[]

Campaign ID filter. Repeat the parameter to include multiple campaigns.

Maximum array length: 100
Maximum string length: 240

Response

Streaming CSV with postId, date, cumulative views/engagement, and daily deltas. A successful empty result contains only the header row.

The response is of type string.