Ad Lift Test Benchmark
Warning
Deprecation Notice
The Marketing version 202209 (Marketing September 2022) and below has been sunset and the unversioned APIs are going to be sunset soon. We recommend that you migrate to the versioned APIs as well as migrate to the new Content and Community Management APIs to avoid disruptions. See the Migration page for more details.
If you haven’t yet migrated and have questions, submit a request on the LinkedIn Developer Support Portal.
Using Brand Lift Testing you can provide advertiser access to the median aggregated lift test results data organized by specific region and industry.
The specific region and industry lift test data are grouped by key metric types. For a description of the key metric types refer to Available Key Metrics.
Note: Brand Lift benchmarks offer empirical guidance and insights rather than data that has been tested and validated for statistical significance.
Tip
For more information about Brand Lift Testing, refer to the Getting Started Guide.
Permissions
Permission | Description |
---|---|
rw_ads | Manage and read an authenticated member's lift tests. Restricted to ad account authenticated members with one of the following roles: |
r_ads | Read an authenticated member's lift tests. Restricted to ad accounts authenticated members with one of the following roles. |
For more information on ad account roles refer to Account Access Controls.
AdLiftTestBenchmarkResult Schema
Field Name | Type | Description | Read only, create only |
---|---|---|---|
benchmarkMetrics | AdLiftTestBenchmarkMetrics[] | Metric array (relativeLift, absoluteLift, etc.) for each existing AdLiftKeyMetric type (advertiser-specific questionsfor measuring results such as AWARENESS, RECALL, etc.) Only advertiser specified questions provide returnable benchmark metrics. See Lift Test Benchmark Metrics Schema for details. | Read Only |
peerGroupType | Enum of: |
Peer group type used for aggregating benchmarking results (e.g., all lift tests identified for the same industry/geographic locale). See Peer Group Type Schema for details. | Read Only |
AdLiftTestBenchmarkMetrics Schema
Field Name | Type | Description | Read only, create only |
---|---|---|---|
benchmarkMetrics | AdLiftResultMetrics | Specific region and industry benchmark metrics. Aligned with the result metrics for lift test measurement. For metric definitions refer to Lift Test metrics schema. | Read Only |
id | AdLiftKeyMetric | The measured lift key metric type using surveys described in lift test key metrics definition. | Read Only |
AdLiftTestBenchmarkPeerGroupType Schema
Symbol | Description |
---|---|
INDUSTRY | Industry selected for lift test |
GEO | Geographic area selected for lift test |
Get Ad Lift Test Benchmark Results Finder
Get Ad Lift Test Benchmark Results Finder fetches benchmark results by using the lift test geographic region and industry to locate peer group URN test results. Key Metric data is returned if it exists and conforms to statistical strength requirements. If no key metric result is returned, then a benchmark group either does not exist or there is not a significant amount of peer group data.
Your request must include the Restli Protocol 2.0.0 as X-Restli-Protocol-Version: 2.0.0
header. Restli 2.0 requires URL encoded URNs in query params. For example, urn:li:adLiftTest:1245678
becomes urn%3Ali%3AadLiftTest%3A1245678
.
Query Parameters
Parameter | Type | Description | Required |
---|---|---|---|
adLiftTest | Ad Lift Test URN | The selected ad lift tests to fetch benchmarking results for | Yes |
Sample Request
GET https://api.linkedin.com/v2/adLiftTestBenchmark?q=adLiftTest&adLiftTests=urn%3Ali%3AadLiftTest%3A{liftTestId}
Sample Response
The API returns benchmark results for a specific lift test. It uses industry and geographic URN values to define a peer group. It fetches median values for the identified group for each key metric. The API returns results if they are available. If no results are returned, there is likely insufficient data to calculate return values.
{
"elements":[
{
"benchmarkMetrics":[
{
"benchmarkMetrics":{
"totalEstimatedLift":62666,
"absoluteLift":0.06563,
"relativeLift":0.726425
},
"id":"RECALL"
}
],
"peerGroupType":"GEO"
},
{
"benchmarkMetrics":[
{
"benchmarkMetrics":{
"totalEstimatedLift":45481,
"absoluteLift":0.074857,
"relativeLift":0.613321
},
"id":"RECALL"
}
],
"peerGroupType":"INDUSTRY"
}
]
}
A successful request returns a 200 OK response code.
Service Error Code
This section documents different Service Error Codes you may encounter. Each Service Error Code represents a unique condition where input can be invalid.
Service Error Code | Http Status | Description |
---|---|---|
BAD_REQUEST | 400 | Malformed requests (e.g., adLiftTestUrn is formatted incorrectly, missing, or more than one is passed in) |
FORBIDDEN | 403 | User is not present or is not authorized to view the lift test. Check to confirm whether the user is a Billing Admin, Account Manager, Campaign Manager, or Viewer. |
NOT_FOUND | 404 | Lift test URN does not exist. |
Feedback
Submit and view feedback for