Skip to content
APIstaging

Incrementality

POST
/api/public/incrementality

Test and control group counts, lift and incrementality per advertiser, action and period, by channel, publisher or campaign.

Incrementality
curl --request POST \
  --url https://backend.podscribe.ai/api/public/incrementality \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "advertiser": "example", "aggregationLevel": "channel", "channelType": "podcast", "action": "example", "startDate": "2026-04-15", "endDate": "2026-04-15", "includeErrors": false, "incCiCertainty": 95 }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
advertiser
required

List of advertiser names separate by comma.

string
aggregationLevel

Aggregation level to use when reporting data.

Default value: channel
Allowed values: channel publisher show_campaign
channelType

Comma-separated list of channel types to report. Only applicable with aggregationLevel ‘channel’. Omit to report every channel type.

Allowed values: podcast streaming all
action

Comma-separated list of actions to report. By default, all actions are reported

string
startDate

Start date timestamp eg 2024-10-01. Default 3 months ago

string<date>
endDate

End date timestamp eg 2024-10-31. Default one week from today

string<date>
includeErrors

Include data with errors leading to no incrementality data.

boolean
Default value: false
incCiCertainty

Confidence interval certainty percent used when computing lift and incrementality confidence interval bounds. Higher certainty produces a wider interval; lower certainty produces a narrower one. Omitted default is 95.

integer
Default value: 95
Allowed range: (1–99)

Response Body

Section titled “Response Body”

An array of incrementality results.

Media typeapplication/json
Array
advertiser

The name of the advertiser.

string
aggregationLevel

Aggregation level used, such as ‘channel’, ‘publisher’, or ‘show_campaign’.

Allowed values: channel publisher show_campaign
channelType

Type of channel (e.g., ‘podcast’, ‘streaming’, ‘all’).

string
action

The action measured for incrementality.

string
startDate

Start date of period over which incrementality is measured.

string<date>
endDate

End date of period over which incrementality is measured.

string<date>
campaignName

Name of the campaign associated with the incrementality data.

string
publisher

Publisher of the campaign.

string
controlGroupActionCount

Action count in the control group.

integer
testGroupActionCount

Action count in the test group.

integer
controlGroupSize

Size of the control group.

integer
testGroupSize

Size of the test group.

integer
lift

Calculated lift between test and control groups.

number<float>
incremental

Calculated Incremental percent between test and control groups.

number<float>
liftConfidenceIntervalLowerBound

Lower bound of the confidence interval for lift percent, at incCiCertainty (default 95).

number<float>
liftConfidenceIntervalUpperBound

Upper bound of the confidence interval for lift percent, at incCiCertainty (default 95).

number<float>
incrementalConfidenceIntervalLowerBound

Lower bound of the confidence interval for incremental percent, at incCiCertainty (default 95).

number<float>
incrementalConfidenceIntervalUpperBound

Upper bound of the confidence interval for incremental percent, at incCiCertainty (default 95).

number<float>
error

Reason incrementality could not be calculated for this result.

string
Response example
[
  {
    "aggregationLevel": "channel"
  }
]