Tealium · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Tealium HTTP Collect API
7 actions
7 updates
phrasing
extends
openapi/tealium-collect-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Tealium's API. It is a proposal applied on top of the contract, not a document Tealium publishes.
What the actions change
x-apievangelist-phrasing
Targets 7
$.info
$.paths['/collect/event'].get
$.paths['/collect/event'].post
$.paths['/collect/bulk-event'].post
$.paths['/collect/regional/event'].post
$.paths['/collect/regional/bulk-event'].post
$.paths['/collect/integration/event/accounts/{account}/profiles/{profile}/datasources/{datasourceId}'].post
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Tealium HTTP Collect API
version: 1.0.0
extends: openapi/tealium-collect-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 6
- target: $.paths['/collect/event'].get
update:
x-apievangelist-phrasing:
intent: Send a tracking event as a pixel GET
effect: write
questions:
- Can I send an event with a plain GET request that returns a tracking pixel?
- Is there a 1x1 GIF image endpoint for pixel-based event tracking?
instructions:
- text: Fire pixel event {tealium_event} for account {tealium_account} profile {tealium_profile} via a GET request.
slots:
tealium_event: query.tealium_event
tealium_account: query.tealium_account
tealium_profile: query.tealium_profile
- text: Send a GET pixel hit for event {tealium_event} on {tealium_account}/{tealium_profile} tied to visitor {tealium_visitor_id}.
slots:
tealium_event: query.tealium_event
tealium_account: query.tealium_account
tealium_profile: query.tealium_profile
tealium_visitor_id: query.tealium_visitor_id
method: generated
generated: '2026-10-01'
- target: $.paths['/collect/event'].post
update:
x-apievangelist-phrasing:
intent: Send one event as a JSON POST
effect: write
questions:
- How do I post a single event to Tealium Collect as a JSON body?
- Can I tag a single JSON event with the deployment environment it came from?
instructions:
- text: POST event {tealium_event} as JSON to the global collect endpoint for {tealium_account} profile {tealium_profile}.
slots:
tealium_event: requestBody.tealium_event
tealium_account: requestBody.tealium_account
tealium_profile: requestBody.tealium_profile
- text: Send a JSON event {tealium_event} for {tealium_account}/{tealium_profile} in environment {tealium_environment} with data source {tealium_datasource}.
slots:
tealium_event: requestBody.tealium_event
tealium_account: requestBody.tealium_account
tealium_profile: requestBody.tealium_profile
tealium_environment: requestBody.tealium_environment
tealium_datasource: requestBody.tealium_datasource
method: generated
generated: '2026-10-01'
- target: $.paths['/collect/bulk-event'].post
update:
x-apievangelist-phrasing:
intent: Send a batch of up to 10 events
effect: write
questions:
- Can I send several tracking events in one request instead of one at a time?
- What is the maximum number of events allowed in a single bulk collect call?
- How do shared fields work when batching events to the global collect endpoint?
instructions:
- text: Send these {events} in one bulk request to the global endpoint with shared fields {shared}.
slots:
events: requestBody.events
shared: requestBody.shared
- text: Batch up to ten events {events} into one global bulk-event call using common fields {shared}.
slots:
events: requestBody.events
shared: requestBody.shared
method: generated
generated: '2026-10-01'
- target: $.paths['/collect/regional/event'].post
update:
x-apievangelist-phrasing:
intent: Send one event to a regional collect host
effect: write
questions:
- How do I send a single event to the region-specific host returned by authentication?
- Can I keep event data routed to my region when posting one event?
instructions:
- text: Send event {tealium_event} for {tealium_account}/{tealium_profile} to the regional collect endpoint.
slots:
tealium_event: requestBody.tealium_event
tealium_account: requestBody.tealium_account
tealium_profile: requestBody.tealium_profile
- text: Post visitor {tealium_visitor_id}'s event {tealium_event} on {tealium_account}/{tealium_profile} through my regional host.
slots:
tealium_visitor_id: requestBody.tealium_visitor_id
tealium_event: requestBody.tealium_event
tealium_account: requestBody.tealium_account
tealium_profile: requestBody.tealium_profile
method: generated
generated: '2026-10-01'
- target: $.paths['/collect/regional/bulk-event'].post
update:
x-apievangelist-phrasing:
intent: Send a batch of events to a regional host
effect: write
questions:
- Can I batch up to 10 events to my region-specific collect endpoint?
- Is there a regional version of the bulk event upload?
instructions:
- text: Send the batch {events} with shared fields {shared} to the regional bulk-event endpoint.
slots:
events: requestBody.events
shared: requestBody.shared
- text: Upload these events {events} in one call to my regional host, applying {shared} to each.
slots:
events: requestBody.events
shared: requestBody.shared
method: generated
generated: '2026-10-01'
- target: $.paths['/collect/integration/event/accounts/{account}/profiles/{profile}/datasources/{datasourceId}'].post
update:
x-apievangelist-phrasing:
intent: Send an event through a webhook data source
effect: write
questions:
- How do I push an event from a webhook into a specific Tealium data source?
- Which endpoint should a connector use to send events to a dedicated integration data source?
instructions:
- text: Send event {tealium_event} to data source {datasourceId} on account {account} profile {profile} via the integration endpoint.
slots:
tealium_event: requestBody.tealium_event
datasourceId: path.datasourceId
account: path.account
profile: path.profile
- text: Forward this webhook as event {tealium_event} into integration data source {datasourceId} for {account}/{profile}.
slots:
tealium_event: requestBody.tealium_event
datasourceId: path.datasourceId
account: path.account
profile: path.profile
method: generated
generated: '2026-10-01'