Skip to main content

Introduction

The documentation for attentionPLAN® API, including attention data, brand uplift, and Attention-adjuted® reach curve endpoints.

Attention data​

The Attention data endpoints provide attention data across a variety of advertising channels and formats.

Developers can use these endpoints to:

  • Query aggregated attention data for a given channel.
  • Get attention data split by advert format collected for a given channel.
  • Filter data by country, age group, gender, time of day, day of week, ad type, ad length, and MRC standard to receive tailored data for your campaign.
  • Retrieve channel's average brand uplift value

Example data returned by the Attention data endpoint:

Request:

{
    "channels": [
        {
            "ad_channel_code": "facebook"
            "ad_format_codes": ["facebook.in-stream-video"]
        }
    ],
    "countries": ["au", "uk", "us"],
    "age_groups": ["18-24", "25-34", "35-44"],
    "genders": ["male", "female", "other"],
    "times_of_day": ["pre-morning", "morning, "afternoon", "evening"],
    "days_of_week": ["monday", "tuesday", "wednesday", "thursday","friday"],
    "ad_types": ["video"],
    "min_ad_length_seconds": 0,
    "max_ad_length_seconds": 5
    "is_only_mrc_compliant": true
}

Response:

[
    {
        "ad_channel": {
            "name": "Facebook",
            "code": "facebook"
        },
        "ad_format": {
            "name": "In-stream video",
            "code": "facebook.in-stream-video"
        },
        "average_active_attention_seconds": 3.00,
        "average_passive_attention_seconds": 5.00,
        "average_inactive_attention_seconds": 2.00,
        "average_ad_length_seconds": 5.00,
        "average_ad_time_on_screen_seconds": 10.00
    }
]

View all available ad channels, formats and other API specification for the Attention data endpoints here.

Attention-adjusted® reach curve​

The Attention-adjusted® reach curve endpoint provides a reach curve with reach values that are curated based on attention data, giving you a view of the attentive, high value audience. With the attention-adjusted® reach curve, you get an attentive reach curve where every impression reaches a certain threshold of attention.

Developers can retrieve a channel's predicted attentive reach curve based on:

  • Advertising formats and budget allocation.
  • Attention data within a specific country, age group, gender.
  • Attention second threshold and attention type.

Example of a baseline and an attention-adjusted reach curve returned via the endpoint: Attention-adjusted reach curve

View the API specification for the Attention-adjusted® reach curve endpoint here.