Skip to main content
GET
/
campaigns
/
v1
/
stats
/
campaigns
Get Campaign Stats
curl --request GET \
  --url https://api-qa.interactly.ai/campaigns/v1/stats/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Query Parameters

​
group_by
enum<string>
default:status

Grouping criteria: status, source, campaignType

Available options:
outcome,
status,
status_outcome,
tag,
source,
campaignType
​
statuses
string[] | null

Filter by one or more campaign statuses

​
tags
string[] | null

Filter tag stats by tag strings (substring match)

​
size
integer
default:300

Number of items per page

Required range: x >= 1
​
page
integer
default:1

Page number

Required range: x >= 1
​
search
string | null

Search keywords

​
start
string<date-time> | null

Filter by start time (ISO 8601 format)

​
end
string<date-time> | null

Filter by end time (ISO 8601 format)

Response

Successful Response