Skip to main content

RankingRequest1

Represents a RankingRequest.

carriers object[]

List of carriers

  • Array [
  • idstring

    Identifier of the Carrier

    Example: 145
    labelstring

    Label of the Carrier

    Example: TV
    typestring

    Type Carrier

    Example: FOLDER,SUPPORT
    pathstring

    Path Carrier identified folders

    Example: FOLDER,SUPPORT
    insertionsinteger<int32>[]

    List insertions on carrier

    Example: [0,1,2,1,0]
  • ]
  • statistics object[]nullable

    List of statistics (Optional)

  • Array [
  • idstring

    Identifier of the Statistic

    Example: COVER
    labelstring

    Label of the Statistic

    Example: Cobertura
    selectedboolean

    Whether this item is the selected one in its axis. Used to pick the slice in the PLANES dimension. Only one item per axis can be marked as selected; sending more than one in the same axis results in a 400 Bad Request.

  • ]
  • titlestring

    Title evaluation

    Example: Title evaluation
    hierarchyboolean

    Table hierarchy active

    target object

    Target

    idstring

    Unique identifier

    Example: A1B2C3D4E5F607182930ABCD12345678
    labelstring

    Human-readable label

    Example: Sample element
    filterTglstring

    Filter in TGL format. May be null when the underlying query is empty or unparseable.

    creationDatestring<date-time>

    ISO-8601 formatted creation date and time including timezone.

    Example: 2025-03-01T16:03:27.592+00:00
    updatedDatestring<date-time>

    ISO-8601 formatted last update date and time including timezone.

    Example: 2025-03-01T16:03:27.592+00:00
    workspaceIdstring

    Workspace id that owns this variable. Populated only by endpoints that perform cross-workspace resolution; null when the caller already has the workspace context.

    Example: A1B2C3D4E5F607182930ABCD12345678
    RankingRequest1
    {
    "carriers": [
    {
    "id": "TVCH1005D1F1",
    "insertions": [
    0,
    1,
    2,
    1,
    0
    ]
    },
    {
    "id": "TVCH1005D2F1",
    "insertions": [
    0,
    1,
    2,
    1,
    0
    ]
    },
    {
    "id": "TVCH1005D3F1",
    "insertions": [
    0,
    1,
    2,
    1,
    0
    ]
    },
    {
    "id": "TVCH1005D4F1",
    "insertions": [
    0,
    1,
    2,
    1,
    0
    ]
    }
    ],
    "statistics": [
    {
    "id": "CONTACT",
    "label": "Contacts"
    },
    {
    "id": "GRP",
    "label": "GRP"
    },
    {
    "id": "COVER",
    "label": "Cover"
    },
    {
    "id": "COVER_PERCENT",
    "label": "Cover Percent"
    }
    ],
    "title": "Title evaluation",
    "hierarchy": true,
    "target": {
    "id": "221351",
    "label": "target 1"
    }
    }