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

# List channel post performance

> Ranks the channel's posts of the range (made in TryPost or not) by one metric, best first, and returns the top 50 a page at a time. Page size is set by the server: read `meta.per_page`. The response also carries the `filters` the server applied. Posts without the metric come last. Same time zone, filters, range clamping and `404` rule as `GET /channels/{account}/insights`.



## OpenAPI

````yaml /openapi.json get /channels/{account}/insights/publications
openapi: 3.1.0
info:
  title: TryPost API
  version: 2.0.0
  description: >-
    REST API for TryPost. Authenticate with a workspace API key as a Bearer
    token.
servers:
  - url: https://app.trypost.it/api
    description: TryPost Cloud
security:
  - bearerAuth: []
tags:
  - name: Posts
    description: Create, read, update, delete and preview posts.
  - name: Post notes
    description: Internal notes on a post, visible to workspace members.
  - name: Approvals
    description: Approve or reject posts waiting for approval.
  - name: Recurrence
    description: Make a post repeat on a schedule.
  - name: Media and uploads
    description: Upload files and attach media to posts.
  - name: Social accounts
    description: Connected social accounts and their network-specific options.
  - name: Channels
    description: A channel's posting schedule and queue.
  - name: Ideas
    description: Ideas on the Create board.
  - name: Idea stages
    description: The groups (columns) of the ideas board.
  - name: Analytics
    description: Workspace and channel insights.
  - name: Labels
    description: Labels to organize posts and ideas.
  - name: Signatures
    description: Reusable text to append to posts.
  - name: Workspace
    description: The workspace the API key belongs to.
  - name: API keys
    description: Personal API keys for this workspace.
  - name: Webhooks
    description: Outgoing webhooks and their delivery logs.
  - name: Repurposes
    description: Automations that republish videos posted outside TryPost.
  - name: Platform
    description: Platform capabilities and content types.
paths:
  /channels/{account}/insights/publications:
    parameters:
      - $ref: '#/components/parameters/AccountId'
    get:
      tags:
        - Analytics
      summary: List channel post performance
      description: >-
        Ranks the channel's posts of the range (made in TryPost or not) by one
        metric, best first, and returns the top 50 a page at a time. Page size
        is set by the server: read `meta.per_page`. The response also carries
        the `filters` the server applied. Posts without the metric come last.
        Same time zone, filters, range clamping and `404` rule as `GET
        /channels/{account}/insights`.
      operationId: listChannelPostPerformance
      parameters:
        - name: range
          in: query
          required: false
          description: >-
            `7d` (last 7 days), `30d` (last 30 days, the default), `mtd` (month
            to date) or `custom`. Days are calendar days in the API key user's
            time zone, today included.
          schema:
            type: string
            enum:
              - 7d
              - 30d
              - mtd
              - custom
            default: 30d
        - name: start
          in: query
          required: false
          description: >-
            First day, `Y-m-d`. Required with `range=custom` and ignored for the
            other presets. Sending `start` and `end` without `range` means
            `custom`.
          schema:
            type: string
            format: date
        - name: end
          in: query
          required: false
          description: >-
            Last day, `Y-m-d`, on or after `start`. Required with
            `range=custom`.
          schema:
            type: string
            format: date
        - name: labels[]
          in: query
          required: false
          style: form
          explode: true
          description: >-
            Only posts with any of these labels (labels of this workspace).
            Unknown or deleted labels return `422`.
          schema:
            type: array
            items:
              type: string
              format: uuid
        - name: untagged
          in: query
          required: false
          description: >-
            Also (or only) posts without labels. Posts made outside TryPost have
            no labels. Send `1` or `0`; `true` and `false` are rejected with
            `422`.
          schema:
            type: string
            enum:
              - '1'
              - '0'
        - name: types[]
          in: query
          required: false
          style: form
          explode: true
          description: Only these content types. They must belong to the channel's network.
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ContentType'
        - name: period
          in: query
          required: false
          description: '`previous` ranks the posts of the previous range of the same length.'
          schema:
            type: string
            enum:
              - current
              - previous
            default: current
        - name: sort
          in: query
          required: false
          description: >-
            Metric to rank by. When the channel does not report it (or it is
            omitted), the first of these the channel reports is used;
            `filters.sort` says which.
          schema:
            type: string
            enum:
              - reactions
              - comments
              - engagement_rate
              - views
              - impressions
              - shares
              - saves
              - reach
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
      responses:
        '200':
          description: A page of ranked posts.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ChannelPostPerformance'
                  links:
                    $ref: '#/components/schemas/PaginationLinks'
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
                  filters:
                    $ref: '#/components/schemas/ChannelInsightsFilters'
              example:
                data:
                  - id: 9d4a0b1c-2d3e-4f5a-8b6c-7d8e9f0a1b2c
                    rank: 1
                    post_id: 9d3c1f2a-6b4e-4c8a-9f1e-2a7b5c8d0e41
                    excerpt: We just shipped scheduled threads. Here is how they work.
                    thumbnail_url: >-
                      https://media.trypost.it/medias/9d3c1f30-8a9b-4c0d-9e1f-2a3b4c5d6e7f.jpg
                    permalink: https://x.com/trypostit/status/1841234567890123456
                    published_at: '2026-10-02T14:00:00+00:00'
                    content_type: image
                    metrics:
                      reactions: 412
                      comments: 38
                      engagement_rate: 5.31
                      views: 9120
                      impressions: 10230
                      shares: null
                      reposts: 41
                      quotes: 6
                      saves: null
                      clicks: 133
                      follows_gained: null
                      reach: null
                      watch_time_minutes: null
                      average_watch_time_seconds: null
                links:
                  first: >-
                    https://app.trypost.it/api/channels/9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54/insights/publications?page=1
                  last: >-
                    https://app.trypost.it/api/channels/9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54/insights/publications?page=1
                  prev: null
                  next: null
                meta:
                  current_page: 1
                  from: 1
                  last_page: 1
                  links:
                    - url: null
                      label: '&laquo; Previous'
                      page: null
                      active: false
                    - url: >-
                        https://app.trypost.it/api/channels/9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54/insights/publications?page=1
                      label: '1'
                      page: 1
                      active: true
                    - url: null
                      label: Next &raquo;
                      page: null
                      active: false
                  path: >-
                    https://app.trypost.it/api/channels/9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54/insights/publications
                  per_page: 25
                  to: 1
                  total: 1
                filters:
                  range: 30d
                  start: '2026-09-09'
                  end: '2026-10-08'
                  period: current
                  sort: reactions
                  labels: []
                  untagged: false
                  types: []
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    AccountId:
      name: account
      in: path
      required: true
      description: >-
        Social account (channel) id. An account of another workspace returns
        `404`.
      schema:
        type: string
        format: uuid
      example: 9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54
  schemas:
    ContentType:
      type: string
      enum:
        - instagram_feed
        - instagram_reel
        - instagram_story
        - linkedin_post
        - linkedin_page_post
        - facebook_post
        - facebook_reel
        - facebook_story
        - tiktok_video
        - tiktok_photo
        - youtube_short
        - x_post
        - threads_post
        - threads_ghost_post
        - pinterest_pin
        - pinterest_video_pin
        - pinterest_carousel
        - bluesky_post
        - mastodon_post
        - telegram_post
        - discord_message
        - google_business_post
      description: >-
        Post format on one network. It must belong to the destination's network.
        `GET /content-types` lists the formats of each network with their media
        rules. Instagram and Facebook stories publish no text.
    ChannelPostPerformance:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Analytics publication id.
        rank:
          type: integer
          description: Position by the `sort` metric, starting at 1.
        post_id:
          type:
            - string
            - 'null'
          format: uuid
          description: TryPost post, or `null` for a post made outside TryPost.
        excerpt:
          type:
            - string
            - 'null'
        thumbnail_url:
          type:
            - string
            - 'null'
        permalink:
          type:
            - string
            - 'null'
        published_at:
          type: string
          format: date-time
          description: ISO 8601, UTC.
        content_type:
          type:
            - string
            - 'null'
          description: Analytics publication type (`text`, `image`, `video`, ...).
        metrics:
          type: object
          description: >-
            `null` for a metric the network does not report. `engagement_rate`
            is a percent.
          properties:
            reactions:
              type:
                - number
                - 'null'
            comments:
              type:
                - number
                - 'null'
            engagement_rate:
              type:
                - number
                - 'null'
            views:
              type:
                - number
                - 'null'
            impressions:
              type:
                - number
                - 'null'
            shares:
              type:
                - number
                - 'null'
            reposts:
              type:
                - number
                - 'null'
            quotes:
              type:
                - number
                - 'null'
            saves:
              type:
                - number
                - 'null'
            clicks:
              type:
                - number
                - 'null'
            follows_gained:
              type:
                - number
                - 'null'
            reach:
              type:
                - number
                - 'null'
            watch_time_minutes:
              type:
                - number
                - 'null'
            average_watch_time_seconds:
              type:
                - number
                - 'null'
    PaginationLinks:
      type: object
      properties:
        first:
          type:
            - string
            - 'null'
        last:
          type:
            - string
            - 'null'
        prev:
          type:
            - string
            - 'null'
        next:
          type:
            - string
            - 'null'
    PaginationMeta:
      type: object
      properties:
        current_page:
          type: integer
        from:
          type:
            - integer
            - 'null'
        last_page:
          type: integer
        links:
          type: array
          items:
            type: object
            properties:
              url:
                type:
                  - string
                  - 'null'
              label:
                type: string
              page:
                type:
                  - integer
                  - 'null'
              active:
                type: boolean
        path:
          type: string
        per_page:
          type: integer
          description: Page size set by the server. Read it; do not assume a value.
        to:
          type:
            - integer
            - 'null'
        total:
          type: integer
    ChannelInsightsFilters:
      type: object
      description: The filters the server applied, after defaults.
      properties:
        range:
          type: string
          enum:
            - 7d
            - 30d
            - mtd
            - custom
        start:
          type: string
          format: date
        end:
          type: string
          format: date
        period:
          type: string
          enum:
            - current
            - previous
        sort:
          type: string
          description: >-
            The sort used: the requested one when the channel reports that
            metric, else the first sortable metric it reports.
        labels:
          type: array
          items:
            type: string
            format: uuid
        untagged:
          type: boolean
        types:
          type: array
          items:
            $ref: '#/components/schemas/ContentType'
    ErrorBody:
      type: object
      properties:
        message:
          type: string
    ValidationErrorBody:
      type: object
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
    RateLimitErrorBody:
      type: object
      properties:
        name:
          type: string
          const: rate_limit_exceeded
        message:
          type: string
          examples:
            - Rate limit exceeded. Please retry after 30 seconds.
  responses:
    Unauthorized:
      description: >-
        Missing, invalid, revoked or expired API key. Bodies: `Unauthenticated.`
        (no key, or a key that is invalid or revoked), `Token expired.` (past
        its `expires_at`), `Token not found.` and `No workspace selected.` (the
        key is no longer bound to a workspace).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            message: Unauthenticated.
    PaymentRequired:
      description: >-
        TryPost Cloud only: the workspace's account has no active subscription
        or trial. Body: `{"message": "Active subscription required."}`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            message: Active subscription required.
    Forbidden:
      description: >-
        The request is not allowed. API keys work only for workspace admins (the
        account owner or a member marked as admin): otherwise every request
        returns `Insufficient workspace permissions.`. Other bodies: `Workspace
        access denied.` (the key's user left the workspace) and `Personal access
        token required.` (an MCP OAuth token was sent) and `This action is
        unauthorized.` (the note belongs to another member).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
    NotFound:
      description: The resource does not exist in this workspace.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
    ValidationError:
      description: Validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorBody'
    TooManyRequests:
      description: 'Rate limit exceeded. Limits: 60 requests per minute per workspace.'
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorBody'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Workspace API key from Settings → API Keys.

````

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