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

# Get mention share of voice

> Splits the podcast lines mentioning an entity by the occupations or fields of the people who said them: what share of what is said about it comes from, say, journalists or economists. A line counts when its speaker is linked to a person with an expertise reading and, for a guest, the appearance read does not doubt it is them; a person counts under every code listed for them, so shares can sum past 1. Ad reads are excluded unless include_ads. The window defaults to the last 30 days and may span 365; interval adds each group's mentions per bucket. Requires entity_id or company_id. For the mentions themselves, use GET /v1/podcasts/mentions; for their counts over time, GET /v1/podcasts/mentions/timeseries.



## OpenAPI

````yaml /openapi.json get /v1/podcasts/mentions/share-of-voice
openapi: 3.1.0
info:
  contact:
    email: api@particle.pro
    name: Particle
    url: https://particle.pro
  description: >-
    Podcast API for transcripts, mentions and sponsorship data. 140,000+
    podcasts transcribed, diarized and speaker-identified within minutes of
    airing, about 28,000 episodes a day. Search transcripts by keyword or
    meaning, track brand and company mentions with alerts, pull sponsor and
    ad-read data and rankings. REST API plus an MCP server for AI agents. Also
    company, people and topic intelligence.
  summary: >-
    Podcast API: transcripts, mentions, sponsors and rankings for 140,000+
    podcasts.
  termsOfService: https://particle.pro/legal/tos-api
  title: Particle API
  version: 0.1.0
  x-guidance: >-
    Podcast, people, company and topic intelligence. Authenticate with a pp_ API
    key (X-API-Key header) or pay per request with x402: a keyless call to a
    billable endpoint returns 402 with the payment requirements in the
    PAYMENT-REQUIRED header; sign the USDC transfer and repeat the request with
    PAYMENT-SIGNATURE. Start with GET /v1/podcasts/search?q=<show name>; the
    slugs in responses are the inputs to the other endpoints. Docs:
    https://docs.particle.pro; setup playbook:
    https://api.particle.pro/agents.md; endpoint and tool map with prices:
    https://api.particle.pro/llms.txt; credential recipe:
    https://api.particle.pro/auth.md.
  x-logo:
    url: https://particle.pro/favicon.svg
servers:
  - url: https://api.particle.pro
security:
  - ApiKeyHeader: []
  - BearerAuth: []
externalDocs:
  url: https://docs.particle.pro
paths:
  /v1/podcasts/mentions/share-of-voice:
    get:
      tags:
        - Podcast Episode Search
        - tier:standard
      summary: Get mention share of voice
      description: >-
        Splits the podcast lines mentioning an entity by the occupations or
        fields of the people who said them: what share of what is said about it
        comes from, say, journalists or economists. A line counts when its
        speaker is linked to a person with an expertise reading and, for a
        guest, the appearance read does not doubt it is them; a person counts
        under every code listed for them, so shares can sum past 1. Ad reads are
        excluded unless include_ads. The window defaults to the last 30 days and
        may span 365; interval adds each group's mentions per bucket. Requires
        entity_id or company_id. For the mentions themselves, use GET
        /v1/podcasts/mentions; for their counts over time, GET
        /v1/podcasts/mentions/timeseries.
      operationId: get-mentions-share-of-voice
      parameters:
        - description: >-
            Entity slug (e.g., 'sam-altman') or ID. Required when company_id is
            not set.
          explode: false
          in: query
          name: entity_id
          schema:
            description: >-
              Entity slug (e.g., 'sam-altman') or ID. Required when company_id
              is not set.
            type: string
        - description: >-
            Company slug, domain, or ID. Required when entity_id is not set.
            Resolves to the company's linked entity.
          explode: false
          in: query
          name: company_id
          schema:
            description: >-
              Company slug, domain, or ID. Required when entity_id is not set.
              Resolves to the company's linked entity.
            type: string
        - description: >-
            Group the speakers by SOC 2018 occupation or ANZSRC 2020 field of
            research.
          explode: false
          in: query
          name: by
          schema:
            default: occupation
            description: >-
              Group the speakers by SOC 2018 occupation or ANZSRC 2020 field of
              research.
            enum:
              - occupation
              - field
            type: string
        - description: >-
            SOC major groups or detailed occupations; ANZSRC divisions or
            groups.
          explode: false
          in: query
          name: level
          schema:
            default: major
            description: >-
              SOC major groups or detailed occupations; ANZSRC divisions or
              groups.
            enum:
              - major
              - detailed
            type: string
        - description: >-
            Attribute every speaker's lines, hosts included, or guests' and
            panelists' only.
          explode: false
          in: query
          name: speakers
          schema:
            default: all
            description: >-
              Attribute every speaker's lines, hosts included, or guests' and
              panelists' only.
            enum:
              - all
              - guests
            type: string
        - description: Restrict to mentions inside one podcast.
          explode: false
          in: query
          name: podcast_id
          schema:
            description: Restrict to mentions inside one podcast.
            type: string
        - description: >-
            Restrict to mentions on podcasts attributed to one publisher
            (network), by slug or ID.
          explode: false
          in: query
          name: publisher_id
          schema:
            description: >-
              Restrict to mentions on podcasts attributed to one publisher
              (network), by slug or ID.
            type: string
        - description: >-
            Mentions inside ad reads are excluded by default. Pass true to
            include them.
          explode: false
          in: query
          name: include_ads
          schema:
            description: >-
              Mentions inside ad reads are excluded by default. Pass true to
              include them.
            type: boolean
        - description: >-
            Only episodes published on or after this date. Defaults to 30 days
            before published_before; the window may span at most 365 days.
          explode: false
          in: query
          name: published_after
          schema:
            description: >-
              Only episodes published on or after this date. Defaults to 30 days
              before published_before; the window may span at most 365 days.
            examples:
              - '2026-09-01'
            type: string
        - description: Only episodes published on or before this date. Defaults to now.
          explode: false
          in: query
          name: published_before
          schema:
            description: Only episodes published on or before this date. Defaults to now.
            examples:
              - '2026-10-01'
            type: string
        - description: Add each group's mentions per bucket of this width.
          explode: false
          in: query
          name: interval
          schema:
            description: Add each group's mentions per bucket of this width.
            enum:
              - day
              - week
              - month
            type: string
        - description: Groups to return, most mentioned first.
          explode: false
          in: query
          name: limit
          schema:
            default: 10
            description: Groups to return, most mentioned first.
            format: int64
            maximum: 50
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareOfVoice'
          description: OK
        '402':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/PlatformError'
          description: >-
            Payment Required. Read error_code. payment_required is the x402
            path: either a keyless request being challenged — pay $0.04 in USDC
            per request (requirements in the PAYMENT-REQUIRED header) or send a
            pp_ API key — or a supplied payment that failed settlement (details
            in the PAYMENT-RESPONSE header; retry the same signature before
            signing a new one). See https://docs.particle.pro/x402. Any other
            code means the credential was accepted but does not cover this
            request (a plan or session gate such as premium_required or
            paid_plan_confirmation_required); its resolve says how to obtain
            access, and no payment header is sent.
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/PlatformError'
          description: Error
      x-codeSamples:
        - label: cURL
          lang: curl
          source: |-
            curl -H "X-API-Key: $PARTICLE_API_KEY" \
              "https://api.particle.pro/v1/podcasts/mentions/share-of-voice?by=occupation&level=major&speakers=all&limit=10"
components:
  schemas:
    ShareOfVoice:
      additionalProperties: false
      properties:
        attributed_mentions:
          description: >-
            Of those, the lines spoken by someone with an expertise reading
            (and, for a guest, whose appearance read does not doubt it is them).
            Shares are of these.
          format: int64
          type: integer
        by:
          description: >-
            What the groups are: SOC 2018 occupations or ANZSRC 2020 fields of
            research.
          enum:
            - occupation
            - field
          type: string
        company:
          $ref: '#/components/schemas/CompanyCompact'
          description: The company the entity was resolved from, when company_id was given.
        end:
          description: >-
            Day the window ends (UTC), excluded: the window is [start, end), so
            a published_before date shows as the day after it.
          type: string
        entity:
          $ref: '#/components/schemas/EntityCompact'
          description: The entity whose mentions are split.
        groups:
          description: >-
            The groups with the most attributed mentions, most first. A person
            listed under several codes counts in each, so shares can sum past 1.
          items:
            $ref: '#/components/schemas/ShareOfVoiceGroup'
          type:
            - array
            - 'null'
        level:
          description: >-
            The groups' level: SOC major groups or detailed occupations; ANZSRC
            divisions or groups.
          enum:
            - major
            - detailed
          type: string
        mentions:
          description: >-
            Lines mentioning the entity in the window, from every speaker. Ad
            reads are left out unless include_ads.
          format: int64
          type: integer
        start:
          description: First day of the window (UTC), included.
          type: string
      required:
        - by
        - level
        - start
        - end
        - mentions
        - attributed_mentions
        - groups
      type: object
    PlatformError:
      additionalProperties: false
      properties:
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        error_code:
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        resolve:
          $ref: '#/components/schemas/ErrorResolve'
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    CompanyCompact:
      additionalProperties: false
      properties:
        description:
          description: Short company description, when known.
          type: string
        domain:
          description: Primary website domain (e.g. 'nvidia.com'), when known.
          type: string
        id:
          description: Company identifier (domain, slug, or encoded ID)
          type: string
        image_url:
          description: Company logo or image URL
          type: string
        name:
          description: Company name
          type: string
        slug:
          description: >-
            Stable human-readable handle (the linked knowledge-graph slug, e.g.
            'nvidia'), when known. Companies have no slug of their own; prefer
            this for display and pass it (or id) to /v1/companies.
          type: string
        ticker:
          description: Primary stock ticker symbol, when listed.
          type: string
      required:
        - id
        - name
      type: object
    EntityCompact:
      additionalProperties: false
      properties:
        company:
          $ref: '#/components/schemas/EntityCompany'
          description: Linked company record, if this entity is a known company
        description:
          description: Short description
          type: string
        id:
          description: Entity ID
          type: string
        image_url:
          description: Entity image URL
          type: string
        name:
          description: Entity name
          type: string
        person:
          $ref: '#/components/schemas/EntityPerson'
          description: Linked person record, if this entity is a known person
        slug:
          description: Human-readable slug identifier
          type: string
        type:
          $ref: '#/components/schemas/EntityType'
          description: Category. Omitted when the entity falls outside the supported set.
        wikipedia_url:
          description: Wikipedia URL
          type: string
      required:
        - id
        - slug
        - name
      type: object
    ShareOfVoiceGroup:
      additionalProperties: false
      properties:
        buckets:
          description: The group's mentions per interval bucket, when interval is set.
          items:
            $ref: '#/components/schemas/ShareOfVoiceBucket'
          type:
            - array
            - 'null'
        code:
          description: The SOC 2018 or ANZSRC 2020 code.
          type: string
        episodes:
          description: Distinct episodes they were said in.
          format: int64
          type: integer
        mentions:
          description: Attributed mention lines spoken by people listed under the code.
          format: int64
          type: integer
        share:
          description: mentions over attributed_mentions (0-1).
          format: double
          type: number
        speakers:
          description: Distinct people who said them.
          format: int64
          type: integer
        title:
          description: The code's title.
          type: string
      required:
        - code
        - title
        - mentions
        - share
        - speakers
        - episodes
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    ErrorResolve:
      additionalProperties: false
      properties:
        action:
          type: string
        endpoint:
          type: string
        message:
          type: string
        method:
          type: string
        url:
          type: string
      required:
        - message
      type: object
    EntityCompany:
      additionalProperties: false
      properties:
        domain:
          description: Company website domain
          type: string
        id:
          description: Company identifier
          type: string
        ticker:
          description: Primary stock ticker symbol
          type: string
      required:
        - id
      type: object
    EntityPerson:
      additionalProperties: false
      properties:
        company:
          description: Current company name
          type: string
        id:
          description: Person identifier
          type: string
        image_url:
          description: Person headshot URL
          type: string
        title:
          description: Current role title
          type: string
      required:
        - id
      type: object
    EntityType:
      additionalProperties: false
      properties:
        name:
          description: Human-friendly display label (e.g. 'Company').
          type: string
        slug:
          description: >-
            Stable identifier, safe to pass to the type query parameter (e.g.
            'company').
          type: string
      required:
        - slug
        - name
      type: object
    ShareOfVoiceBucket:
      additionalProperties: false
      properties:
        mentions:
          format: int64
          type: integer
        start:
          description: First day of the bucket (UTC).
          type: string
      required:
        - start
        - mentions
      type: object
  securitySchemes:
    ApiKeyHeader:
      description: Pass your API key in the X-API-Key header (recommended).
      in: header
      name: X-API-Key
      type: apiKey
    BearerAuth:
      description: Pass your API key as a Bearer token in the Authorization header.
      scheme: bearer
      type: http

````

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