Optimly Reports API

The Reports API from Optimly — 9 operation(s) for reports.

GitHub OpenAPI

Operations 9

GET /api/reports/{report_id} Get Report #
POST /api/reports/{report_id}/view Record Report View #
GET /api/reports/{report_id}/questions Get Report Questions #
GET /api/reports/{report_id}/sources Get Report Sources #
GET /api/reports/{report_id}/recommendations List Report Recommendations #
GET /api/v2/reports Get Keyed Reports #
GET /api/v2/reports/{report_id} Get Keyed Report #
GET /api/v2/reports/{report_id}/questions Get Keyed Report Questions #
GET /api/v2/reports/{report_id}/sources Get Keyed Report Sources #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/optimly-ai:optimly-ai-reports-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

optimly-ai-reports-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Optimly Reports API
  version: 0.1.0
tags:
- name: Reports
paths:
  /api/reports/{report_id}:
    get:
      summary: Get Report
      operationId: get_report_api_reports__report_id__get
      parameters:
      - name: report_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Report Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Report Api Reports  Report Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Reports
  /api/reports/{report_id}/view:
    post:
      summary: Record Report View
      description: 'Record that this customer kept the report on screen for five seconds.


        The beacon is fire-and-forget and may arrive more than once (remount,

        retry, a second tab); `(report_id, user_id)` is unique, so only the first

        qualifying view is kept. The report must belong to the caller''s org — the

        same 404-not-403 rule as every other report route.'
      operationId: record_report_view_api_reports__report_id__view_post
      parameters:
      - name: report_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Report Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              title: Payload
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Reports
  /api/reports/{report_id}/questions:
    get:
      summary: Get Report Questions
      description: 'Question Analysis — payload builder shared with the keyed

        API (api/report_views.py), so the two surfaces cannot drift.'
      operationId: get_report_questions_api_reports__report_id__questions_get
      parameters:
      - name: report_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Report Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Report Questions Api Reports  Report Id  Questions Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Reports
  /api/reports/{report_id}/sources:
    get:
      summary: Get Report Sources
      description: Sources — payload builder shared with the keyed API.
      operationId: get_report_sources_api_reports__report_id__sources_get
      parameters:
      - name: report_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Report Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Report Sources Api Reports  Report Id  Sources Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Reports
  /api/reports/{report_id}/recommendations:
    get:
      summary: List Report Recommendations
      operationId: list_report_recommendations_api_reports__report_id__recommendations_get
      parameters:
      - name: report_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Report Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response List Report Recommendations Api Reports  Report Id  Recommendations Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Reports
  /api/v2/reports:
    get:
      summary: Get Keyed Reports
      description: 'All reports for the key''s brand, newest version first — same rows as

        the app list.'
      operationId: get_keyed_reports_api_v2_reports_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Get Keyed Reports Api V2 Reports Get
      tags:
      - Reports
  /api/v2/reports/{report_id}:
    get:
      summary: Get Keyed Report
      description: 'Report detail: frozen summary metrics, the run''s panel snapshot, and

        the run block — same shape as the app route.'
      operationId: get_keyed_report_api_v2_reports__report_id__get
      parameters:
      - name: report_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Report Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Keyed Report Api V2 Reports  Report Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Reports
  /api/v2/reports/{report_id}/questions:
    get:
      summary: Get Keyed Report Questions
      description: 'Question Analysis: every question with per-model answers

        and judgments — the same payload the SPA renders.'
      operationId: get_keyed_report_questions_api_v2_reports__report_id__questions_get
      parameters:
      - name: report_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Report Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Keyed Report Questions Api V2 Reports  Report Id  Questions Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Reports
  /api/v2/reports/{report_id}/sources:
    get:
      summary: Get Keyed Report Sources
      description: 'Sources: per-domain citation aggregation with

        owned/competitor/third-party classification.'
      operationId: get_keyed_report_sources_api_v2_reports__report_id__sources_get
      parameters:
      - name: report_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Report Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Keyed Report Sources Api V2 Reports  Report Id  Sources Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Reports
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError