> ## 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.

# Summarize a podcast's ratings

> Returns the numeric aggregate of a podcast's ratings — one entry per (platform, locale) it has been rated on, a combined cross-source roll-up, and the latest LLM-generated narrative summary of recent review text when one has been generated.



## OpenAPI

````yaml /openapi.json get /v1/podcasts/{id}/ratings/summary
openapi: 3.1.0
info:
  description: Public API for Particle — news intelligence, financial data, and analysis.
  title: Particle API
  version: 0.1.0
servers:
  - url: https://api.particle.pro
security:
  - ApiKeyHeader: []
  - BearerAuth: []
paths:
  /v1/podcasts/{id}/ratings/summary:
    get:
      tags:
        - Podcast Ratings
        - tier:standard
      summary: Summarize a podcast's ratings
      description: >-
        Returns the numeric aggregate of a podcast's ratings — one entry per
        (platform, locale) it has been rated on, a combined cross-source
        roll-up, and the latest LLM-generated narrative summary of recent review
        text when one has been generated.
      operationId: get-podcast-ratings-summary
      parameters:
        - description: Podcast slug, internal ID, or numeric iTunes ID.
          in: path
          name: id
          required: true
          schema:
            description: Podcast slug, internal ID, or numeric iTunes ID.
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PodcastRatingsSummary'
          description: OK
        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/{id}/ratings/summary"
components:
  schemas:
    PodcastRatingsSummary:
      additionalProperties: false
      properties:
        combined:
          $ref: '#/components/schemas/PodcastRatingSummaryEntry'
          description: >-
            Single roll-up across every entry, computed by weighting each
            entry's average by its rating_count. Null when the podcast has no
            ratings yet.
        entries:
          description: One entry per (platform, locale) the podcast has been rated on.
          items:
            $ref: '#/components/schemas/PodcastRatingSummaryEntry'
          type:
            - array
            - 'null'
        podcast_id:
          description: Internal podcast ID.
          type: string
        sentiment:
          $ref: '#/components/schemas/PodcastRatingSentimentSummary'
          description: >-
            Latest LLM-generated narrative summary. Null until enough ratings
            have accumulated for the popularity-bucket cadence to generate one.
      required:
        - podcast_id
        - entries
      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
    PodcastRatingSummaryEntry:
      additionalProperties: false
      properties:
        computed_at:
          description: When this summary was last computed.
          format: date-time
          type: string
        histogram:
          $ref: '#/components/schemas/PodcastRatingHistogram'
          description: Per-star counts.
        locale:
          description: >-
            Platform-specific locale code. Empty for platforms without a locale
            dimension or for the cross-locale roll-up.
          type: string
        platform_slug:
          description: Canonical platform identifier.
          type: string
        rating_average:
          description: Arithmetic mean of stars across the aggregated ratings.
          format: double
          type: number
        rating_count:
          description: Total ratings the summary aggregates.
          format: int64
          type: integer
      required:
        - platform_slug
        - rating_count
        - rating_average
        - histogram
        - computed_at
      type: object
    PodcastRatingSentimentSummary:
      additionalProperties: false
      properties:
        generated_at:
          description: When the LLM produced this summary.
          format: date-time
          type: string
        locale:
          description: Locale the summary is scoped to (empty for cross-locale roll-up).
          type: string
        platform_slug:
          description: >-
            Platform the summary is scoped to (empty for cross-platform
            roll-up).
          type: string
        rating_count_in_window:
          description: How many ratings the summary aggregates.
          format: int64
          type: integer
        summary_text:
          description: Narrative summary paragraph.
          type: string
        window_end:
          description: Latest rating posted_at in the window the summary covers.
          format: date-time
          type: string
        window_start:
          description: Earliest rating posted_at in the window the summary covers.
          format: date-time
          type: string
      required:
        - summary_text
        - rating_count_in_window
        - generated_at
      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
    PodcastRatingHistogram:
      additionalProperties: false
      properties:
        stars_1:
          description: Number of 1-star ratings.
          format: int64
          type: integer
        stars_2:
          description: Number of 2-star ratings.
          format: int64
          type: integer
        stars_3:
          description: Number of 3-star ratings.
          format: int64
          type: integer
        stars_4:
          description: Number of 4-star ratings.
          format: int64
          type: integer
        stars_5:
          description: Number of 5-star ratings.
          format: int64
          type: integer
      required:
        - stars_1
        - stars_2
        - stars_3
        - stars_4
        - stars_5
      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

````