> ## Documentation Index
> Fetch the complete documentation index at: https://docs.athenahq.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List TikTok Pages

> List TikTok URLs cited in AI answers, ordered by citations. Includes profile, video, photo and unattributed URLs. Filter by channel_key from get_tiktok_creators. Each page's share_percent and totals use all filtered TikTok citations, including unattributed URLs, even when drilling into one channel or paginating. These are AI-answer citation counts, not TikTok views or engagement. No scraping or live TikTok requests. Dates are inclusive UTC days. Results are cached for up to five minutes. Citation counts measure Athena-tracked AI answers, not TikTok views, followers or engagement. Handles are lowercase and do not reconcile account renames or verify ownership. Pagination is zero-based with at most 100 rows per page. The creators pagination total includes an unattributed group when present; totals.channels excludes it. Page URL strings preserve the Sources grouping key and may omit the scheme. Tracking-only query variants and text fragments are grouped as on Sources.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/sources/tiktok-pages
openapi: 3.1.0
info:
  title: AthenaHQ API
  description: >-
    AthenaHQ API provides programmatic access to manage your websites and
    prompts for AI-powered content optimization.
  version: 1.0.0
  contact:
    email: support@athenahq.ai
servers:
  - url: https://api.athenahq.ai
    description: Production server
security:
  - apiKey: []
tags:
  - name: Basics
    description: Core API operations for managing websites and prompts
  - name: Metrics
    description: Metrics and analytics endpoints for tracking AI visibility
  - name: Billing
    description: Billing and credits endpoints for managing usage
  - name: Team Management
    description: Endpoints for managing team members and invitations
  - name: Groups
    description: Endpoints for managing groups of websites
  - name: Content
    description: >-
      Endpoints for accessing Content Hub data — tabs, tracked URLs, and per-URL
      prompt breakdowns.
  - name: Pitch Workspace
    description: >-
      Endpoints for accessing pitch workspace reports — org-scoped pitch runs
      with competitors, prompts, attributes, and aggregate metrics.
  - name: Knowledge Base
    description: >-
      Endpoints for reading the brand Knowledge Base — approved brand facts and
      the pillars that organize them.
paths:
  /api/v1/sources/tiktok-pages:
    post:
      tags:
        - Sources
      summary: List TikTok Pages
      description: >-
        List TikTok URLs cited in AI answers, ordered by citations. Includes
        profile, video, photo and unattributed URLs. Filter by channel_key from
        get_tiktok_creators. Each page's share_percent and totals use all
        filtered TikTok citations, including unattributed URLs, even when
        drilling into one channel or paginating. These are AI-answer citation
        counts, not TikTok views or engagement. No scraping or live TikTok
        requests. Dates are inclusive UTC days. Results are cached for up to
        five minutes. Citation counts measure Athena-tracked AI answers, not
        TikTok views, followers or engagement. Handles are lowercase and do not
        reconcile account renames or verify ownership. Pagination is zero-based
        with at most 100 rows per page. The creators pagination total includes
        an unattributed group when present; totals.channels excludes it. Page
        URL strings preserve the Sources grouping key and may omit the scheme.
        Tracking-only query variants and text fragments are grouped as on
        Sources.
      operationId: sources.tiktokPages
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                website_id:
                  type: string
                  format: uuid
                  pattern: >-
                    ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                filters:
                  type: object
                  properties:
                    start_date:
                      type: string
                      format: date
                      pattern: >-
                        ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
                      description: First day, YYYY-MM-DD, inclusive (UTC).
                    schedule_id:
                      description: >-
                        One schedule: "default" or a custom/archived schedule
                        UUID. Omit for Default, which includes all pre-cutover
                        history and ad hoc runs. The retired "manual" token is
                        accepted as an alias of "default". Schedules cannot be
                        combined.
                      anyOf:
                        - type: string
                          enum:
                            - default
                            - manual
                        - type: string
                          format: uuid
                          pattern: >-
                            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                    end_date:
                      description: >-
                        Last day, YYYY-MM-DD, inclusive (UTC). Defaults to
                        today.
                      type: string
                      format: date
                      pattern: >-
                        ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
                    models:
                      description: >-
                        AI models to include, as an array even for one model —
                        e.g. ["chatgpt", "perplexity"]. Omit to include all
                        models.
                      type: array
                      items:
                        type: string
                        enum:
                          - chatgpt
                          - perplexity
                          - gemini
                          - google_ai_overview
                          - copilot
                          - claude
                          - ai_mode
                          - grok
                          - deepseek
                          - meta_ai
                          - mistral
                    prompt_ids:
                      description: >-
                        Prompt UUIDs to filter to, as an array even for one id.
                        Omit for all prompts.
                      type: array
                      items:
                        type: string
                        format: uuid
                        pattern: >-
                          ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                    location_ids:
                      description: >-
                        Location UUIDs to filter to, as an array even for one
                        id. The literal string "no-location" selects responses
                        that ran without a location. Omit for all locations.
                      type: array
                      items:
                        anyOf:
                          - type: string
                            format: uuid
                            pattern: >-
                              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                          - type: string
                            const: no-location
                    persona_ids:
                      description: >-
                        Persona UUIDs to filter to, as an array even for one id.
                        Omit for all personas.
                      type: array
                      items:
                        type: string
                        format: uuid
                        pattern: >-
                          ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                    target_identifiers:
                      description: >-
                        Target identifier strings to filter to, as an array even
                        for one value. The literal string "no-identifier"
                        selects responses with no target identifier. Omit for
                        all.
                      type: array
                      items:
                        anyOf:
                          - type: string
                          - type: string
                            const: no-identifier
                    variation_filter:
                      description: >-
                        Which prompt rows to include, as an array: "prompt" for
                        base prompts, "variation" for generated variations, or
                        both. Omit for both.
                      type: array
                      items:
                        type: string
                        enum:
                          - variation
                          - prompt
                    prompt_tags:
                      description: Prompt tag UUIDs from get_prompt_tags.
                      type: array
                      items:
                        type: string
                        format: uuid
                        pattern: >-
                          ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                    prompt_tags_operator:
                      description: >-
                        How prompt_tags combine: "is_any_of" matches prompts
                        with any listed tag, "has_all_of" only prompts carrying
                        every listed tag.
                      type: string
                      enum:
                        - is_any_of
                        - has_all_of
                    prompt_status:
                      description: >-
                        Filter prompts by tracking status: "active" or "paused".
                        Omit for both.
                      type: string
                      enum:
                        - active
                        - paused
                    prompt_type:
                      description: >-
                        Filter prompts by type: "branded" (mentions the brand)
                        or "non_branded". Omit for both.
                      type: string
                      enum:
                        - branded
                        - non_branded
                  required:
                    - start_date
                  additionalProperties: false
                page_num:
                  default: 0
                  description: Zero-based page number.
                  type: integer
                  minimum: 0
                  maximum: 1000000
                page_size:
                  type: integer
                  minimum: 1
                  maximum: 100
                  default: 30
                channel_key:
                  type: string
                  minLength: 1
                  maxLength: 500
                  description: >-
                    Group key from get_tiktok_creators, including unattributed;
                    omit for all cited pages.
              required:
                - website_id
                - filters
            example:
              website_id: 123e4567-e89b-42d3-a456-426614174000
              filters:
                start_date: '2026-10-01'
                end_date: '2026-10-31'
              page_num: 0
              page_size: 30
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  pages:
                    type: array
                    items:
                      type: object
                      properties:
                        url:
                          type: string
                        channel:
                          type: object
                          properties:
                            channel_key:
                              type: string
                              description: >-
                                URL-derived handle group key; use with
                                get_tiktok_pages. The unattributed group has key
                                unattributed.
                            handle:
                              type:
                                - string
                                - 'null'
                            url:
                              type:
                                - string
                                - 'null'
                          required:
                            - channel_key
                            - handle
                            - url
                          additionalProperties: false
                        citations:
                          type: number
                        share_percent:
                          type: number
                      required:
                        - url
                        - channel
                        - citations
                        - share_percent
                      additionalProperties: false
                  pagination:
                    type: object
                    properties:
                      page_num:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      page_size:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      total:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                    required:
                      - page_num
                      - page_size
                      - total
                    additionalProperties: false
                  totals:
                    type: object
                    properties:
                      citations:
                        type: number
                      channels:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                        description: Attributed handles, excluding the unattributed group.
                      unattributed_citations:
                        type: number
                    required:
                      - citations
                      - channels
                      - unattributed_citations
                    additionalProperties: false
                  notice:
                    type: string
                required:
                  - pages
                  - pagination
                  - totals
                additionalProperties: false
        '400':
          description: Bad Request — validation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '429':
          description: Rate Limited
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
      security:
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. You can create one
        [here](https://app.athenahq.ai/organization?tab=api).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.