Console API

Ads performance

1 endpoint.

GET/api/v1/admin/businesses/{business_id}/ads/campaigns/{campaign_id}/performance

Campaign daily performance series + ladder flags

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`campaign_id`required	path	`string (uuid)`
`windowDays`	query	`integer`	default 28
`from`	query	`string (date) \| null`
`to`	query	`string (date) \| null`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_CampaignPerformanceData_

Field Type Description

request_idrequired string

success true default true

datarequired

CampaignPerformanceData

CampaignPerformanceData fields

Field Type Description

seriesrequired

PerformanceSeriesPoint[]

PerformanceSeriesPoint[] fields

PerformanceSeriesPoint (not expanded)

firstDataDate string | null

lastDataDate string | null

lastSyncAt string | null

tokenFailing boolean default false

campaignFlag

FlagSummary | null

FlagSummary fields

Field	Type	Description
`status`required	`enum`	one of "healthy", "watch", "underperforming"
`score`	`integer \| null`
`recommendedAction`required	`enum`	one of "refresh_creative", "refresh_audience", "refresh_campaign", "none"
`reasons`	`object[]`	object[] fields Nested object (not expanded)
`since`	`string \| null`

adSetFlags

AdSetFlagSummary[]

AdSetFlagSummary[] fields

AdSetFlagSummary (not expanded)

adUnitFlags

AdUnitFlagSummary[]

AdUnitFlagSummary[] fields

AdUnitFlagSummary (not expanded)

metadata

ResponseMetadata | null

ResponseMetadata fields

Field Type Description

pagination

PaginationMetadata | null

PaginationMetadata fields

Field	Type	Description
`limit`required	`integer`
`next_cursor`	`string \| null`
`prev_cursor`	`string \| null`
`has_more`required	`boolean`
`has_prev`	`boolean`	default false
`total_count`	`integer \| null`

status_counts

object | null

object | null fields

Map of string to integer

lifecycle_counts

LifecycleCounts | null

LifecycleCounts fields

Field	Type	Description
`lead`	`integer`	default 0
`prospect`	`integer`	default 0
`customer`	`integer`	default 0
`former_customer`	`integer`	default 0

classification_counts

ClassificationCounts | null

ClassificationCounts fields

Field	Type	Description
`signal`	`object`	object fields Nested object (not expanded)
`touch`	`object`	object fields Nested object (not expanded)
`stage`	`object`	object fields Nested object (not expanded)

meta

ResponseMeta | null

ResponseMeta fields

Field	Type	Description
`total`	`integer \| null`
`total_count`	`integer \| null`
`page`	`integer \| null`
`per_page`	`integer \| null`

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.