Ctrlk
My Account
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Stats

The Stats API provides aggregated mailing performance data across your campaigns. Use these endpoints to pull circulation and spend metrics for reporting and analytics integrations.

Fetch Campaign Stats

GET https://api.heypoplar.com/v1/stats/campaigns

Returns aggregated stats across all campaigns for your organization, including total circulation, total spend, and a paginated list of per-campaign breakdowns. Optionally filter by date range.

Headers

Name
Type
Description

Authorization*

string

Bearer ProductionAccessToken

Query Parameters

Name
Type
Description

start_date

string

ISO8601 date to limit results to campaigns with activity on or after this date

Example: 2024-01-01

end_date

string

ISO8601 date to limit results to campaigns with activity on or before this date

Example: 2024-03-31

page

number

Page of results to return

default: 1 maximum: 10000

per_page

number

Number of campaigns to return per page

default: 25 maximum: 30

{
    "total_circulation": 45200,
    "total_spend": 29380.00,
    "total_campaign_count": 3,
    "start_date": "2024-01-01",
    "end_date": "2024-03-31",
    "page": 1,
    "total_pages": 1,
    "campaigns": [
        {
            "campaign_id": "25358f3d-121e-4b07-b2fa-4ed8c7054ac1",
            "campaign_name": "Prospecting USA Q1 2024",
            "circulation": 20000,
            "spend": 13000.00
        },
        {
            "campaign_id": "aef13242-e4a9-4494-857f-2acc1c3337f6",
            "campaign_name": "Retargeting Spring 2024",
            "circulation": 15200,
            "spend": 9880.00
        },
        {
            "campaign_id": "c4b37e00-9163-4b4e-be3e-65fea6f5a165",
            "campaign_name": "New Movers March 2024",
            "circulation": 10000,
            "spend": 6500.00
        }
    ]
}

Fetch Campaign Stats by ID

GET https://api.heypoplar.com/v1/stats/campaign/:id

Returns circulation and spend stats for a single campaign.

Headers

Name
Type
Description

Authorization*

string

Bearer ProductionAccessToken

Path Parameters

Name
Type
Description

id*

string

Campaign ID

Query Parameters

Name
Type
Description

start_date

string

ISO8601 date to limit results to campaigns with activity on or after this date

Example: 2024-01-01

end_date

string

ISO8601 date to limit results to campaigns with activity on or before this date

Example: 2024-03-31

Response Fields

Collection (stats/campaigns)

Field
Type
Description

total_circulation

integer

Total number of pieces mailed across all campaigns in the result

total_spend

float

Total spend in USD across all campaigns in the result

total_campaign_count

PreviousData Subject RequestsNextOther Endpoints

Last updated