GET /api/v1/study/{studyId}/report

Retrieve the report of a specific brand lift study by its ID.

Path parameters

The following table lists the path parameters that you need to provide to make a request.

Parameter	Required?	Data Type	Description
`studyId`	Required	String	The ID of the study for which you want to retrieve the report.

Response example

A successful response returns the aggregated report for the study with a list of aggregated report data organized by question.

{
  "impressionNumber": 652357,
  "reportForQuestions": {
    "ad-recall": [
      {
        "reportSliceName": "Gender",
        "bucketName": "Female",
        "bucketOrder": 1,
        "exposedCount": 500,
        "inTargetExposedCount": 350,
        "exposedPercentage": 0.75,
        "controlCount": 500,
        "inTargetControlCount": 300,
        "controlPercentage": 0.6,
        "totalCount": 1000,
        "liftPercentage": 0.15,
        "confidenceLevel": 0.95,
        "marginOfError": 0.05,
        "isStatisticallySignificant": true,
        "isSufficientSampleSize": true
      }
    ],
    "market-awareness": [
      {
        "reportSliceName": "Age",
        "bucketName": "29 to 39",
        "bucketOrder": 1,
        "exposedCount": 500,
        "inTargetExposedCount": 350,
        "exposedPercentage": 0.75,
        "controlCount": 500,
        "inTargetControlCount": 300,
        "controlPercentage": 0.6,
        "totalCount": 1000,
        "liftPercentage": 0.15,
        "confidenceLevel": 0.95,
        "marginOfError": 0.05,
        "isStatisticallySignificant": true,
        "isSufficientSampleSize": true
      }
    ]
  }
}

Response properties

The following table lists the GET /api/v1/study/{studyId}/report response properties.

Property	Required?	Data Type	Description
`impressionNumber`	Optional	Integer (int64)	The number of impressions that you received for the study.
`reportForQuestions`	Required	Object Array	The list of report objects for each question by name and the aggregated report data associated with them. For property descriptions in each item of the array, see Report object.

Report object

The following table lists the object properties for each report object in the reportForQuestions array.

Property	Data Type	Description
`reportSliceName`	String(256)	The name of the slice or group of responses in a report that you set up during the initial setup process. For example: `Overall`, `Frequency`, `Gender`, `Age`, `Site`, `Creative`, and so on.
`bucketName`	String(64)	The name of the bucket or a group of responses within the report slice that are organized by a dimension specified by the provider. The following lists some examples of a bucket: In a Gender report slice, common `bucketName` values include `Male` and `Female`. In an Age report slice, common `bucketName` values include age groups such as `20 to 39`. TIP: This value appears in the report on the platform as is with no modifications. Be sure to create a readable bucket name.
`bucketOrder`	Integer (int32)	The order in which the bucket name will be presented in the report or chart.
`exposedCount`	Integer (int32)	The number of responses from the exposed group of the survey. In other words, the group of respondents who were exposed to the campaign.
`inTargetExposedCount`	Integer (int32)	The number of responses from the exposed group that chose the in-target answer.
`exposedPercentage`	Decimal	The percentage of responses in the exposed group (the people in the study who were exposed to the campaign) who chose the in-target answer. You determine how this percentage is calculated. NOTE: Advertisers see this value as `pts` or points instead of a percentage. For example, a value of `0.1` appears as `10pts` in the platform UI.
`controlCount`	Integer (int32)	The number of responses in the control group of the survey. In other words, the number of responses that were not exposed to the campaign.
`inTargetControlCount`	Integer (int32)	The number of responses that chose the in-target answer in the control group of the bucket.
`controlPercentage`	Decimal	The percentage, calculated by the provider, of the in-target responses in the control group of the results in the bucket. NOTE: Advertisers see this value as `pts` or points instead of a percentage. For example, a value of `0.1` appears as `10pts` in the platform UI.
`totalCount`	Integer (int32)	The total number of responses within the bucket or group.
`liftPercentage`	Decimal	The percentage of brand lift calculated by the provider. NOTE: Advertisers see this value as `pts` or points instead of a percentage. For example, a value of `0.1` appears as `10pts` in the platform UI.
`confidenceLevel`	Decimal	The percentage that measures the level of confidence the provider has in the calculated lift percentage.
`marginOfError`	Decimal	The margin of error (MOE) percentage that measures the level of accuracy of the survey question results. This percentage is typically calculated by comparing the number of people who took the survey to the population in which the survey took place.
`isStatisticallySignificant`	Boolean	If set to `true`, indicates the results of this question have statistical significance.
`isSufficientSampleSize`	Boolean	If set to `true`, indicates that enough responses have been received to generate a meaningful result. If set to `false`, indicates that this question received insufficient responses. All results in this report slice are hidden to the advertiser.