Developer centerAPI keys

TVTouchpoint

Overview

Technical name: TVTouchpoint · ActionType: 25

Use TVTouchpoint for a TV-related interaction connected to an IH-configured destination or campaign. Define the recorded touchpoint and attribution mapping during integration setup.

Open in REST Explorer

Requirements and Inputs

InputApplicability
ActionKeyTokenRequired: an ActionKey provisioned for TVTouchpoint (25).
Campaign, destination and identity contextUse the signals and attribution mapping agreed for the TV integration.
Landing URL (419), session ID (403), timestamp (400)Illustrative context for a QR-to-web journey; other TV integrations may use a different agreed signal set.

All requests use the shared User Action endpoint. Provisioning determines required identity and destination signals. Optional fields are defined in Action Fields.

Request Examples

Replace YOUR_ACTION_KEY with the correctly provisioned token. The first example shows the basic shape for this context; add all signals required by your integration. These examples do not provision an action or guarantee a production-valid identity.

Basic request

{
  "ActionKeyToken": "YOUR_ACTION_KEY",
  "Values": [
    {
      "SignalValueType": 419,
      "DataType": 0,
      "UnitType": 0,
      "Value": "https://brand.example.com/tv",
      "OptionIDs": {}
    },
    {
      "SignalValueType": 403,
      "DataType": 0,
      "UnitType": 0,
      "Value": "example-tv-001",
      "OptionIDs": {}
    }
  ]
}

With additional context

{
  "ActionKeyToken": "YOUR_ACTION_KEY",
  "Values": [
    {
      "SignalValueType": 419,
      "DataType": 0,
      "UnitType": 0,
      "Value": "https://brand.example.com/tv",
      "OptionIDs": {}
    },
    {
      "SignalValueType": 403,
      "DataType": 0,
      "UnitType": 0,
      "Value": "example-tv-001",
      "OptionIDs": {}
    },
    {
      "SignalValueType": 400,
      "DataType": 0,
      "UnitType": 0,
      "Value": "2026-10-21T12:00:00Z",
      "OptionIDs": {}
    },
    {
      "SignalValueType": 407,
      "DataType": 0,
      "UnitType": 0,
      "Value": "example-tv-campaign",
      "OptionIDs": {}
    }
  ]
}

Expected Result

The shared response may contain Result, correlation identifiers, and configured signals. Read the returned values according to the configured model and product. Do not assume every action returns an IH Score or the same response fields.

See the response contract and API Results and Errors. An HTTP response or accepted event alone does not prove downstream delivery or a business outcome.

Processing and Feedback

Confirm which touchpoint is recorded, how attribution is carried, and how it correlates to later web, call, or purchase activity. For a TV-to-web journey, follow the Intelligent TV and Engagement Plan page setup and readiness checks.

When reporting an observed outcome, use Disposition (19) and its correlation rules. Never reuse a different ActionType ActionKey as an outcome key.

Delivery and Troubleshooting

This guide documents API submission. Use only other delivery methods explicitly provisioned for your integration. If a request fails, verify the API key, the exact ActionKey type, required signal values, and the actual HTTP and API result. Review retry/correlation behavior before resubmitting after a timeout.

Related Documentation