Tealium · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tealium Visitor Profile Customer API

3 actions 3 updates phrasing extends openapi/tealium-customer-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.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/customer/visitor/accounts/{account}/profiles/{profile}'].get

$.paths['/customer/visitor/historical/accounts/{account}/profiles/{profile}'].get

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 Visitor Profile Customer API
  version: 1.0.0
extends: openapi/tealium-customer-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: 2
- target: $.paths['/customer/visitor/accounts/{account}/profiles/{profile}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a visitor's full profile
      effect: read
      questions:
      - How do I fetch a visitor's audiences, badges and attributes by their email or customer ID?
      - Can I search live data first and fall back to historical data for a visitor profile?
      - How many attributes can I filter a visitor profile response down to?
      instructions:
      - text: Get the visitor profile in {account}/{profile} where attribute {attributeId} equals {attributeValue}, checking live and historical data.
        slots:
          account: path.account
          profile: path.profile
          attributeId: query.attributeId
          attributeValue: query.attributeValue
      - text: Look up visitor {attributeValue} by attribute {attributeId} in {account}/{profile} searching only {searchPriority} data.
        slots:
          attributeValue: query.attributeValue
          attributeId: query.attributeId
          account: path.account
          profile: path.profile
          searchPriority: query.searchPriority
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customer/visitor/historical/accounts/{account}/profiles/{profile}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a visitor's historical profile only
      effect: read
      questions:
      - How do I get only the stored historical profile for a visitor, not live data?
      - How long after a visit does historical visitor data become available?
      instructions:
      - text: Get the historical-only profile for visitor {attributeValue} using attribute {attributeId} in {account}/{profile}.
        slots:
          attributeValue: query.attributeValue
          attributeId: query.attributeId
          account: path.account
          profile: path.profile
      - text: Pull historical data for visitor {attributeValue} (attribute {attributeId}) in {account}/{profile}, limited to attributes {responseFilters}.
        slots:
          attributeValue: query.attributeValue
          attributeId: query.attributeId
          account: path.account
          profile: path.profile
          responseFilters: query.responseFilters
      method: generated
      generated: '2026-10-01'