stable · api · 0.1.0

Record a verified Viewable Impression

POST /api/v1/advertising/viewable-impressions

Capability Domain: Advertising Sponsorship

Authentication

No authentication required

Scope: None

Parameters and request body

Request schema

application/json

application/json request schema

{
    "type": "object",
    "additionalProperties": false,
    "required": [
        "token",
        "visible_ratio_basis_points",
        "duration_milliseconds"
    ],
    "properties": {
        "token": {
            "type": "string",
            "maxLength": 4096
        },
        "visible_ratio_basis_points": {
            "type": "integer",
            "minimum": 0,
            "maximum": 10000
        },
        "duration_milliseconds": {
            "type": "integer",
            "minimum": 0,
            "maximum": 3600000
        }
    }
}

application/json request example

{
    "token": "signed-ad-decision-token",
    "visible_ratio_basis_points": 5000,
    "duration_milliseconds": 1000
}

Responses and errors

Status	Description
`200`	Deduplicated Viewable Impression and any atomic CPM charge
`422`	The token is invalid, expired, or does not meet the viewability threshold

200 schema

200 response schema

{
    "type": "object",
    "required": [
        "data"
    ],
    "properties": {
        "data": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "recorded",
                "charged_minor",
                "destination_url"
            ],
            "properties": {
                "recorded": {
                    "type": "boolean"
                },
                "charged_minor": {
                    "type": "integer",
                    "minimum": 0
                },
                "destination_url": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "format": "uri"
                },
                "attribution_token": {
                    "type": [
                        "string",
                        "null"
                    ]
                }
            }
        }
    }
}

200 example

200 response example

{
    "data": {
        "recorded": true,
        "charged_minor": 0,
        "destination_url": null,
        "attribution_token": null
    }
}

Idempotency

The signed decision token deduplicates repeated Viewable Impression submissions.