Incrementality Results

POST

/api/public/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": "example", "endDate": "example", "includeErrors": "example" }'

Authorizations

• BearerAuth

Request Body^required

Media typeapplication/json

object

advertiser

required

List of advertiser names separate by comma.

string

aggregationLevel

Aggregation level to use when reporting data. Default ‘channel’

string

Allowed values: channel publisher show_campaign

channelType

Comma-separated list of channel types to report. Only applicable with aggregationLevel ‘channel’. Default ‘all’

string

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

endDate

End date timestamp eg 2024-10-31. Default today

string

includeErrors

Include data with errors leading to no incremetality data. Default False

string

Responses

200

An array of incrementality results.

Media typeapplication/json

Array<object>

object

advertiser

The name of the advertiser.

string

aggregationLevel

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

string

channelType

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

string

action

The action measured for incrementality.

string

country

Country code where the data applies.

string

Allowed values: GLOBAL US GB CA AU DE FR MX IE JP ES IN BR IT AR KR SA AE ID EG SG

startDate

Start date of period over which incrementality is measured.

string format: date

endDate

End date of period over which incrementality is measured.

string format: 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 format: float

incremental

Calculated Incremental percent between test and control groups.

number format: float

liftConfidenceIntervalLowerBound

Lower bound of the confidence interval for lift percent.

number format: float

liftConfidenceIntervalUpperBound

Upper bound of the confidence interval for lift percent.

number format: float

incrementalConfidenceIntervalLowerBound

Lower bound of the confidence interval for incremental percent.

number format: float

incrementalConfidenceIntervalUpperBound

Upper bound of the confidence interval for incremental percent.

number format: float

Example

[
  {
    "country": "GLOBAL"
  }
]

400

Invalid data

500

Unexpected error.

Media typeapplication/json

object

message

Nodejs Error

object

Example^generated

{
  "message": {}
}