Skip to main content

ResponseCurve

Response curve of a media plan, one entry per plan.

intervalsstring[]

Contact ranges the curve was calculated with, as labels (N, from-to or >N). Every distribution and accumulated array has this same length and order.

statisticList object[]

The two statistics the curves are expressed in, COVER_PERCENT and PERCENT_COVER, named and explained in the language of the user.

  • Array [
  • idstring

    Identifier of the statistic, as returned by GET /api/v2/statistics. Send it in a STATISTICS axis.

    labelstring

    Display label, in the language of the user.

    descriptionstring

    Explanation of what the statistic measures, in the language of the user.

    selectedboolean

    Not returned by GET /api/v2/statistics. In table requests and responses it marks the selected statistic of an axis; in a PLANES axis several can be selected (one matrix each), in any other axis at most one.

  • ]
  • total object

    Every plan taken together. Present only when the request sets includeTotalPlan.

    insertionsinteger<int32>

    Insertions of the calculation. For the total plan, the sum of every plan.

    statistics object

    Totals of the plan: cover, cover percentage, contacts, GRP, OTS and maximum cover. They are weighted when the request sends weightings or memorizationCoefficient.

    covernumber<double>

    People within the target reached at least once by the plan (statistic COVER).

    coverPercentnumber<double>

    Cover as a percentage of the universe. Matches the first accumulated value of the COVER_PERCENT curve.

    contactnumber<double>

    Total impacts delivered by the plan (statistic CONTACT).

    grpnumber<double>

    Gross Rating Points: contacts as a percentage of the universe (statistic GRP).

    otsnumber<double>

    Opportunities To See: average impacts per person reached, contacts divided by cover (statistic OTS). Absent when the cover is zero.

    coverMaxnumber<double>

    Maximum reachable cover with the carriers of the plan (statistic COVER_MAX).

    curves object[]

    Two curves, always COVER_PERCENT first and PERCENT_COVER second.

  • Array [
  • statisticstring

    Statistic the curve is expressed in. COVER_PERCENT: share of the universe (or of the target population). PERCENT_COVER: share of the people the plan reaches; its first accumulated value is 100 when the plan reaches anyone, and 0 otherwise. statisticList at the root of the response explains both.

    Enum ValueDescription
    COVER_PERCENTShare of the universe, or of the target population.
    PERCENT_COVERShare of the people the plan reaches.

    Possible values: [COVER_PERCENT, PERCENT_COVER]

    distributionnumber<double>[]

    Share of the audience reached exactly the number of times of the matching intervals entry, in percentage points (0-100).

    accumulatednumber<double>[]

    Share reached at least that number of times (the 1+, 2+, 3+ reading), in percentage points (0-100). This is the response curve.

  • ]
  • plans object[]

    One entry per plan the request defines, in that same order.

  • Array [
  • insertionsinteger<int32>

    Insertions of the calculation. For the total plan, the sum of every plan.

    statistics object

    Totals of the plan: cover, cover percentage, contacts, GRP, OTS and maximum cover. They are weighted when the request sends weightings or memorizationCoefficient.

    covernumber<double>

    People within the target reached at least once by the plan (statistic COVER).

    coverPercentnumber<double>

    Cover as a percentage of the universe. Matches the first accumulated value of the COVER_PERCENT curve.

    contactnumber<double>

    Total impacts delivered by the plan (statistic CONTACT).

    grpnumber<double>

    Gross Rating Points: contacts as a percentage of the universe (statistic GRP).

    otsnumber<double>

    Opportunities To See: average impacts per person reached, contacts divided by cover (statistic OTS). Absent when the cover is zero.

    coverMaxnumber<double>

    Maximum reachable cover with the carriers of the plan (statistic COVER_MAX).

    curves object[]

    Two curves, always COVER_PERCENT first and PERCENT_COVER second.

  • Array [
  • statisticstring

    Statistic the curve is expressed in. COVER_PERCENT: share of the universe (or of the target population). PERCENT_COVER: share of the people the plan reaches; its first accumulated value is 100 when the plan reaches anyone, and 0 otherwise. statisticList at the root of the response explains both.

    Enum ValueDescription
    COVER_PERCENTShare of the universe, or of the target population.
    PERCENT_COVERShare of the people the plan reaches.

    Possible values: [COVER_PERCENT, PERCENT_COVER]

    distributionnumber<double>[]

    Share of the audience reached exactly the number of times of the matching intervals entry, in percentage points (0-100).

    accumulatednumber<double>[]

    Share reached at least that number of times (the 1+, 2+, 3+ reading), in percentage points (0-100). This is the response curve.

  • ]
  • indexinteger<int32>

    Position of the plan in insertions, starting at 1.

    labelstring

    Name given to the plan in the request planLabels. Absent when the request did not name it.

  • ]
  • ResponseCurve
    {
    "intervals": [
    "string"
    ],
    "statisticList": [
    {
    "id": "string",
    "label": "string",
    "description": "string",
    "selected": true
    }
    ],
    "total": {
    "insertions": 0,
    "statistics": {
    "cover": 0,
    "coverPercent": 0,
    "contact": 0,
    "grp": 0,
    "ots": 0,
    "coverMax": 0
    },
    "curves": [
    {
    "statistic": "COVER_PERCENT",
    "distribution": [
    0
    ],
    "accumulated": [
    0
    ]
    }
    ]
    },
    "plans": [
    {
    "insertions": 0,
    "statistics": {
    "cover": 0,
    "coverPercent": 0,
    "contact": 0,
    "grp": 0,
    "ots": 0,
    "coverMax": 0
    },
    "curves": [
    {
    "statistic": "COVER_PERCENT",
    "distribution": [
    0
    ],
    "accumulated": [
    0
    ]
    }
    ],
    "index": 0,
    "label": "string"
    }
    ]
    }