CiteLadder Search Intelligence API

The search-intelligence API from CiteLadder — 2 operation(s) for search-intelligence.

Documentation GitHub OpenAPI

Operations 2

GET /v1/projects/{project_id}/search-intelligence/runs Get projects by project id search intelligence runs #

GET /v1/projects/{project_id}/search-intelligence/datasets/{dataset_id}/rows Get projects by project id search intelligence datasets by dataset id rows #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/citeladder-com/openapi/citeladder-com-search-intelligence-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-search-intelligence-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

openapi: 3.2.0
info:
  title: CiteLadder Search Intelligence API
  version: '1'
servers:
- url: https://api.citeladder.com
security:
- apiKey: []
tags:
- name: search-intelligence
paths:
  /v1/projects/{project_id}/search-intelligence/runs:
    get:
      tags:
      - search-intelligence
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SearchRun'
      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: offset
        in: query
        required: false
        schema:
          default: 0
          type: integer
          minimum: 0
          maximum: 9007199254740991
      - name: limit
        in: query
        required: false
        schema:
          default: 25
          type: integer
          minimum: 1
          maximum: 100
      x-citeladder-scope: read
      summary: Get projects by project id search intelligence runs
      x-summary-source: derived
      operationId: getV1ProjectsByProjectIdSearchIntelligenceRuns
      x-operation-id-source: derived
  /v1/projects/{project_id}/search-intelligence/datasets/{dataset_id}/rows:
    get:
      tags:
      - search-intelligence
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchDatasetPage'
      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: dataset_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: cursor
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 2048
          - type: 'null'
      - name: limit
        in: query
        required: false
        schema:
          default: 50
          type: integer
          minimum: 1
          maximum: 200
      - name: sort
        in: query
        required: false
        schema:
          default: id
          type: string
      - name: direction
        in: query
        required: false
        schema:
          default: asc
          type: string
          enum:
          - asc
          - desc
      - name: search
        in: query
        required: false
        schema:
          default: ''
          type: string
          maxLength: 200
      - name: min_volume
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            minimum: 0
            maximum: 9007199254740991
          - type: 'null'
      - name: intent
        in: query
        required: false
        schema:
          default: ''
          type: string
          maxLength: 100
      x-citeladder-scope: read
      summary: Get projects by project id search intelligence datasets by dataset id rows
      x-summary-source: derived
      operationId: getV1ProjectsByProjectIdSearchIntelligenceDatasetsByDatasetIdRows
      x-operation-id-source: derived
components:
  schemas:
    SearchRun:
      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)$
        status:
          type: string
        action:
          type: string
        pricing_version:
          type: string
        credential_mode:
          type: string
          enum:
          - byok
          - funded
        estimated_cost_usd:
          type:
          - string
          - 'null'
        provider_reported_cost_usd:
          type:
          - string
          - 'null'
        estimated_credits:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
        charged_credits:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
        planned_calls:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        completed_calls:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        planned_rows:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        received_rows:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        uncertain_calls:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        error_code:
          type: string
        error_detail:
          type: string
        expires_at:
          type: string
        confirmed_at:
          type:
          - string
          - 'null'
        cancelled_at:
          type:
          - string
          - 'null'
        completed_at:
          type:
          - string
          - 'null'
        frozen_scope:
          type: object
          propertyNames:
            type: string
          additionalProperties: {}
        call_plan:
          type: array
          items:
            type: object
            propertyNames:
              type: string
            additionalProperties: {}
        reused_datasets:
          type: array
          items:
            type: object
            propertyNames:
              type: string
            additionalProperties: {}
        created_at:
          type: string
      required:
      - id
      - status
      - action
      - pricing_version
      - credential_mode
      - estimated_cost_usd
      - provider_reported_cost_usd
      - estimated_credits
      - charged_credits
      - planned_calls
      - completed_calls
      - planned_rows
      - received_rows
      - uncertain_calls
      - error_code
      - error_detail
      - expires_at
      - confirmed_at
      - cancelled_at
      - completed_at
      - frozen_scope
      - call_plan
      - reused_datasets
      - created_at
      additionalProperties: false
    SearchDataset:
      type: object
      properties:
        research_scope:
          $ref: '#/components/schemas/ResearchScope'
        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)$
        run_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)$
        dataset_kind:
          type: string
        target_domain:
          type: string
        target_hostname:
          type: string
        target_origin:
          type: string
        acquisition:
          type: object
          propertyNames:
            type: string
          additionalProperties: {}
        comparison_origin:
          type: string
        location_code:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
        language_code:
          type: string
        status:
          type: string
        coverage:
          type: string
        requested_rows:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        raw_rows_received:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        unique_rows_saved:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        provider_total:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
        truncated:
          type: boolean
        summary:
          type: object
          propertyNames:
            type: string
          additionalProperties: {}
        collection_started_at:
          type:
          - string
          - 'null'
        collection_ended_at:
          type:
          - string
          - 'null'
        published_at:
          type:
          - string
          - 'null'
        filtered_saved_count:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
      required:
      - research_scope
      - id
      - run_id
      - dataset_kind
      - target_domain
      - target_hostname
      - target_origin
      - acquisition
      - comparison_origin
      - location_code
      - language_code
      - status
      - coverage
      - requested_rows
      - raw_rows_received
      - unique_rows_saved
      - provider_total
      - truncated
      - summary
      - collection_started_at
      - collection_ended_at
      - published_at
      additionalProperties: {}
    SearchRow:
      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)$
        dataset_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)$
        call_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'
        row_kind:
          type: string
        keyword:
          type: string
        domain:
          type: string
        url:
          type: string
        search_volume:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
        difficulty:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
        intent:
          type: string
        rank_group:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
        owned_rank_group:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
        etv:
          type:
          - string
          - 'null'
        backlinks:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
        referring_main_domains:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
        dataforseo_rank:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
        auxiliary:
          type: object
          propertyNames:
            type: string
          additionalProperties: {}
        action_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'
      required:
      - id
      - dataset_id
      - call_id
      - row_kind
      - keyword
      - domain
      - url
      - search_volume
      - difficulty
      - intent
      - rank_group
      - owned_rank_group
      - etv
      - backlinks
      - referring_main_domains
      - dataforseo_rank
      - auxiliary
      additionalProperties: {}
    ResearchScope:
      type: string
      enum:
      - exact_host
      - domain_subdomains
    SearchDatasetPage:
      type: object
      properties:
        dataset:
          $ref: '#/components/schemas/SearchDataset'
        rows:
          type: array
          items:
            $ref: '#/components/schemas/SearchRow'
        next_cursor:
          type:
          - string
          - 'null'
      required:
      - dataset
      - rows
      - next_cursor
      additionalProperties: false
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'An API key created in Settings → API keys, sent as `Authorization: Bearer cl_live_…`.'