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

# List the monthly reports

> The project's frozen monthly reports, newest first. Agency plans only.



## OpenAPI

````yaml /api-reference/openapi.json get /projects/{projectId}/reports
openapi: 3.1.0
info:
  title: Citino API
  version: v1
  description: >-
    Read how AI engines answer your market's questions, and keep your prompts,
    competitors, segments and engines in step from code. Every number carries
    its band and sample size.
servers:
  - url: https://api.citino.ai/v1
security:
  - bearerAuth: []
tags:
  - name: Brand and competitors
  - name: Definitions
  - name: Engines
  - name: Projects
  - name: Alerts
  - name: Attribution
  - name: Claims
  - name: Crawlability
  - name: Crawler activity
  - name: Metrics
  - name: Experiments
  - name: Prompts
  - name: Objections
  - name: Monthly reports
  - name: Reports
  - name: Runs
  - name: Searches
  - name: Sources
  - name: Work items
  - name: Settings
paths:
  /projects/{projectId}/reports:
    get:
      tags:
        - Monthly reports
      summary: List the monthly reports
      description: The project's frozen monthly reports, newest first. Agency plans only.
      operationId: getProjectsByProjectIdReports
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
        - name: cursor
          in: query
          required: false
          description: 'A month, YYYY-MM: the page starts before it.'
          schema:
            description: 'A month, YYYY-MM: the page starts before it.'
            type: string
            pattern: ^\d{4}-\d{2}$
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        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)$
                        period:
                          type: string
                          pattern: ^\d{4}-\d{2}$
                        period_start:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2}$
                        period_end:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2}$
                        as_of:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2}$
                        provisional:
                          type: boolean
                        month_to_date:
                          type: boolean
                        generated_at:
                          type: string
                        revoked:
                          type: boolean
                          description: The shared link was revoked.
                      required:
                        - id
                        - period
                        - period_start
                        - period_end
                        - as_of
                        - provisional
                        - month_to_date
                        - generated_at
                        - revoked
                      additionalProperties: false
                  next_cursor:
                    type:
                      - string
                      - 'null'
                  has_more:
                    type: boolean
                required:
                  - items
                  - next_cursor
                  - has_more
                additionalProperties: false
              example:
                items:
                  - id: 00000000-0000-4000-8000-000000000001
                    period: 2026-09
                    period_start: '2026-09-01'
                    period_end: '2026-09-30'
                    as_of: '2026-09-30'
                    provisional: false
                    month_to_date: false
                    generated_at: '2026-11-07T09:00:00.000Z'
                    revoked: false
                next_cursor: null
                has_more: false
        '400':
          description: The request is invalid; `error.field` names the parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'No live API key in an `Authorization: Bearer` header.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The key lacks the scope named in the message, or cannot write.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such resource in this key's projects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Over the key's or the workspace's rate limit; see `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Busy or timed out; retry after `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
        - lang: bash
          label: curl
          source: |-
            curl "https://api.citino.ai/v1/projects/{projectId}/reports" \
              -H "Authorization: Bearer $CITINO_API_KEY"
        - lang: python
          label: Python
          source: |-
            import os
            import requests

            res = requests.get(
                "https://api.citino.ai/v1/projects/{projectId}/reports",
                headers={"Authorization": f"Bearer {os.environ['CITINO_API_KEY']}"},
            )
            print(res.json())
        - lang: javascript
          label: JavaScript
          source: >-
            const res = await
            fetch("https://api.citino.ai/v1/projects/{projectId}/reports", {
              headers: {
                Authorization: `Bearer ${process.env.CITINO_API_KEY}`,
              },
            });

            console.log(await res.json());
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: >-
                validation, unauthorized, forbidden, not_found, conflict,
                plan_limit, rate_limited, busy, query_timeout
            message:
              type: string
            field:
              type: string
            detail:
              type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key from Workspace settings → API keys, sent as `Authorization:
        Bearer <key>`.

````

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