Skip to main content
GET
/
advertising
/
api
/
v1
/
reporting
/
campaigns
/
{campaign_id}
/
summary
Campaign summary metrics
curl --request GET \
  --url https://www.closient.com/advertising/api/v1/reporting/campaigns/{campaign_id}/summary \
  --header 'X-API-Key: <api-key>'
{
  "campaign_id": "<string>",
  "campaign_name": "<string>",
  "status": "draft",
  "totals": {
    "impressions": 123,
    "clicks": 123,
    "spend": "<string>",
    "ctr": "<string>",
    "effective_cpc": "<string>",
    "effective_cpm": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.closient.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
campaign_id
string<shortuuid>
required

UUID of the campaign.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

200 - application/json

OK

​
campaign_id
string<shortuuid>
required

UUID of the campaign.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
​
campaign_name
string
required

Name of the campaign.

​
status
enum<string>
required

Current campaign status.

Available options:
draft,
active,
paused,
completed,
archived
​
totals
SummaryTotals · object
required

Lifetime aggregated totals.

Example:
{
  "clicks": 5780,
  "ctr": "1.50",
  "effective_cpc": "0.50",
  "effective_cpm": "7.51",
  "impressions": 385000,
  "spend": "2890.00"
}