We’ve migrated our documentation to a new site, which means some URLs have changed.
Audience

/reports/propensity/distribution

Report distribution of propensity scores for a given site, i.e. how many users currently have a given propensity score.

This API is experimental and requires the experimental flag, it might change at any time without warning.

The user must be authenticated and have read permissions to the given site.

Request

The request object has the following fields:

Name

Type

Required

Description

siteId

String

No

The siteID to get the distribution for.

If no siteId is provided, distribution for all available sites for which the user has read access will be returned.

Response

The response is an object with the following fields:

Name

Type

Description

sites

Array of Object

Array of objects with fields as below, one for each site.

Name

Type

Description

siteId

String

The siteID the propensity distribution is for.

distribution

Array of Number

The distribution of scores, as an array of 100 floating point numbers in [0, 1] indicating the ratio of users with propensity scores [0,1), [1,2), ..., [99, 100]. The ratios might not add up to 1, in which case the remainder is the ratio of users that did not receive a propensity score.

date

String

The UTC date in format yyyy-MM-dd when the distribution was last computed

Last updated: