Tealium · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tealium Visitor Privacy API

5 actions 5 updates phrasing extends openapi/tealium-privacy-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 5

$.info

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

$.paths['/privacy/visitor/accounts/{account}/profiles/{profile}'].delete

$.paths['/privacy/visitor/accounts/{account}/profiles/{profile}/transactions/{transaction_id}'].get

$.paths['/privacy/visitor/accounts/{account}/profiles/{profile}/ids'].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 Privacy API
  version: 1.0.0
extends: openapi/tealium-privacy-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: 4
- target: $.paths['/privacy/visitor/accounts/{account}/profiles/{profile}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a visitor's data for a privacy request
      effect: read
      questions:
      - How do I export everything stored about a person to answer a GDPR access request?
      - Can I pull a visitor's full record for a CCPA data subject request?
      instructions:
      - text: Retrieve all data held on visitor {attributeValue} (attribute {attributeId}) in {account}/{profile} for a privacy access request.
        slots:
          attributeValue: query.attributeValue
          attributeId: query.attributeId
          account: path.account
          profile: path.profile
      - text: Run a GDPR lookup for {attributeValue} by attribute {attributeId} in {account}/{profile} with readable attribute names.
        slots:
          attributeValue: query.attributeValue
          attributeId: query.attributeId
          account: path.account
          profile: path.profile
      method: generated
      generated: '2026-10-01'
- target: $.paths['/privacy/visitor/accounts/{account}/profiles/{profile}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Erase a visitor's data for GDPR or CCPA
      effect: destructive
      questions:
      - How do I delete a person's data from the Customer Data Hub for a right-to-be-forgotten request?
      - How long does a visitor data erasure take to complete?
      instructions:
      - text: Submit an erasure request for visitor {attributeValue} identified by attribute {attributeId} in {account}/{profile}.
        slots:
          attributeValue: requestBody.attributeValue
          attributeId: requestBody.attributeId
          account: path.account
          profile: path.profile
      - text: Delete all profile data for {attributeValue} (attribute {attributeId}) from {account}/{profile} and give me the transaction ID.
        slots:
          attributeValue: requestBody.attributeValue
          attributeId: requestBody.attributeId
          account: path.account
          profile: path.profile
      method: generated
      generated: '2026-10-01'
- target: $.paths['/privacy/visitor/accounts/{account}/profiles/{profile}/transactions/{transaction_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a data deletion request
      effect: read
      questions:
      - Has my visitor deletion request finished yet?
      - What statuses can a privacy erasure transaction be in?
      instructions:
      - text: Check deletion transaction {transaction_id} for {account}/{profile}.
        slots:
          transaction_id: path.transaction_id
          account: path.account
          profile: path.profile
      - text: Tell me whether erasure {transaction_id} in {account}/{profile} is pending, succeeded or failed.
        slots:
          transaction_id: path.transaction_id
          account: path.account
          profile: path.profile
      method: generated
      generated: '2026-10-01'
- target: $.paths['/privacy/visitor/accounts/{account}/profiles/{profile}/ids'].get
  update:
    x-apievangelist-phrasing:
      intent: List the visitor ID attributes for a profile
      effect: read
      questions:
      - Which visitor ID attributes are configured, and what are their numeric IDs?
      - Where do I find a valid attributeId to use in a privacy lookup?
      instructions:
      - text: List the visitor ID attributes configured for {account}/{profile}.
        slots:
          account: path.account
          profile: path.profile
      - text: Map the numeric visitor ID attribute IDs to names for profile {profile} on account {account}.
        slots:
          account: path.account
          profile: path.profile
      method: generated
      generated: '2026-10-01'