CiteLadder

CiteLadder Performance API

The performance API from CiteLadder — 2 operation(s) for performance.

GitHub OpenAPI

Operations 2

GET /v1/projects/{project_id}/performance Get projects by project id performance #
GET /v1/projects/{project_id}/performance/table Get projects by project id performance table #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/citeladder-com/openapi/citeladder-com-performance-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/citeladder-com/json-schema/citeladder-com-visibility-ads-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/citeladder-com/json-schema/citeladder-com-action-detail-schema.json
📊
JSONSchema
https://artifacts.apis.io/citeladder-com/json-schema/citeladder-com-visibility-sources-schema.json
📊
JSONSchema
https://artifacts.apis.io/citeladder-com/json-schema/citeladder-com-prompt-metric-item-schema.json
📊
JSONSchema
https://artifacts.apis.io/citeladder-com/json-schema/citeladder-com-perception-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/citeladder-com/json-schema/citeladder-com-audit-estimate-schema.json

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/citeladder-com:citeladder-com-performance-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. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

citeladder-com-performance-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: CiteLadder Performance API
  version: '1'
servers:
- url: https://api.citeladder.com
security:
- apiKey: []
tags:
- name: Performance
paths:
  /v1/projects/{project_id}/performance:
    get:
      tags:
      - Performance
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  project_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)$
                  range:
                    type: string
                  granularity:
                    type: string
                  compare:
                    type: string
                  selected:
                    $ref: '#/components/schemas/PerformanceWindow'
                  comparison:
                    anyOf:
                    - $ref: '#/components/schemas/PerformanceWindow'
                    - type: 'null'
                  coverage:
                    type: object
                    properties:
                      earliest_date:
                        type:
                        - string
                        - 'null'
                      latest_date:
                        type:
                        - string
                        - 'null'
                      covered_days:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      analytics_quality:
                        default: {}
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties:
                          type: array
                          items:
                            type: object
                            properties:
                              day:
                                type: string
                              revision:
                                type:
                                - number
                                - 'null'
                              flags:
                                type: array
                                items:
                                  type: string
                            required:
                            - day
                            - revision
                            - flags
                            additionalProperties: false
                    required:
                    - earliest_date
                    - latest_date
                    - covered_days
                    - analytics_quality
                    additionalProperties: false
                  dimension_counts:
                    type: object
                    properties:
                      query:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      page:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      country:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      device:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      search_appearance:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      day:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      bing_query:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      bing_page:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                    required:
                    - query
                    - page
                    - country
                    - device
                    - search_appearance
                    - day
                    - bing_query
                    - bing_page
                    additionalProperties: false
                  unavailable_dimensions:
                    type: array
                    items:
                      type: string
                  formula_version:
                    type: string
                  normalization_version:
                    type: string
                required:
                - project_id
                - range
                - granularity
                - compare
                - selected
                - comparison
                - coverage
                - dimension_counts
                - unavailable_dimensions
                - formula_version
                - normalization_version
                additionalProperties: false
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          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)$
      - name: range
        in: query
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: from
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
            pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          - type: 'null'
      - name: to
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
            pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          - type: 'null'
      - name: compare
        in: query
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: compare_from
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
            pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          - type: 'null'
      - name: compare_to
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
            pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          - type: 'null'
      - name: granularity
        in: query
        required: false
        schema:
          type:
          - string
          - 'null'
      x-citeladder-scope: read
      summary: Get projects by project id performance
      x-summary-source: derived
      operationId: getV1ProjectsByProjectIdPerformance
      x-operation-id-source: derived
  /v1/projects/{project_id}/performance/table:
    get:
      tags:
      - Performance
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  dimension:
                    type: string
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        dimension_key:
                          type: string
                        display_value:
                          type: string
                        metrics:
                          $ref: '#/components/schemas/PerformanceMetrics'
                        comparison_metrics:
                          anyOf:
                          - $ref: '#/components/schemas/PerformanceMetrics'
                          - type: 'null'
                      required:
                      - dimension_key
                      - display_value
                      - metrics
                      - comparison_metrics
                      additionalProperties: false
                  next_cursor:
                    type:
                    - string
                    - 'null'
                  total_count:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  page_size:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                required:
                - dimension
                - items
                - next_cursor
                - total_count
                - page_size
                additionalProperties: false
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          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)$
      - name: snapshot_id
        in: query
        required: true
        schema:
          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)$
      - name: dimension
        in: query
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: sort
        in: query
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: cursor
        in: query
        required: false
        schema:
          type:
          - string
          - 'null'
      - name: page_size
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
      - name: compare_snapshot_id
        in: query
        required: false
        schema:
          anyOf:
          - 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)$
          - type: 'null'
      x-citeladder-scope: read
      summary: Get projects by project id performance table
      x-summary-source: derived
      operationId: getV1ProjectsByProjectIdPerformanceTable
      x-operation-id-source: derived
components:
  schemas:
    PerformanceWindow:
      type: object
      properties:
        snapshot_id:
          anyOf:
          - 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)$
          - type: 'null'
        window_start:
          type: string
        window_end:
          type: string
        evidence_state:
          type: string
          enum:
          - not_run
          - observed_zero
          - available
        totals:
          type: object
          properties:
            clicks:
              anyOf:
              - type: integer
                minimum: -9007199254740991
                maximum: 9007199254740991
              - type: 'null'
            impressions:
              anyOf:
              - type: integer
                minimum: -9007199254740991
                maximum: 9007199254740991
              - type: 'null'
            ctr:
              type:
              - number
              - 'null'
            position:
              type:
              - number
              - 'null'
            sessions:
              anyOf:
              - type: integer
                minimum: -9007199254740991
                maximum: 9007199254740991
              - type: 'null'
            key_events:
              type:
              - number
              - 'null'
          required:
          - clicks
          - impressions
          - ctr
          - position
          - sessions
          - key_events
          additionalProperties: false
        series:
          type: object
          properties:
            clicks:
              type: array
              items:
                type: object
                properties:
                  date:
                    type: string
                  value:
                    type:
                    - number
                    - 'null'
                required:
                - date
                - value
                additionalProperties: false
            impressions:
              type: array
              items:
                type: object
                properties:
                  date:
                    type: string
                  value:
                    type:
                    - number
                    - 'null'
                required:
                - date
                - value
                additionalProperties: false
            ctr:
              type: array
              items:
                type: object
                properties:
                  date:
                    type: string
                  value:
                    type:
                    - number
                    - 'null'
                required:
                - date
                - value
                additionalProperties: false
            position:
              type: array
              items:
                type: object
                properties:
                  date:
                    type: string
                  value:
                    type:
                    - number
                    - 'null'
                required:
                - date
                - value
                additionalProperties: false
          required:
          - clicks
          - impressions
          - ctr
          - position
          additionalProperties: false
      required:
      - snapshot_id
      - window_start
      - window_end
      - evidence_state
      - totals
      - series
      additionalProperties: false
    PerformanceMetrics:
      type: object
      properties:
        clicks:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
        impressions:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
        ctr:
          type:
          - number
          - 'null'
        position:
          type:
          - number
          - 'null'
      required:
      - clicks
      - impressions
      - ctr
      - position
      additionalProperties: false
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'An API key created in Settings → API keys, sent as `Authorization: Bearer cl_live_…`.'