CiteLadder

CiteLadder Site Health API

The site-health API from CiteLadder — 1 operation(s) for site-health.

GitHub OpenAPI

Operations 1

GET /v1/projects/{project_id}/site-health Get projects by project id site health #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/citeladder-com/openapi/citeladder-com-site-health-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-site-health-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-site-health-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: CiteLadder Site Health API
  version: '1'
servers:
- url: https://api.citeladder.com
security:
- apiKey: []
tags:
- name: site-health
paths:
  /v1/projects/{project_id}/site-health:
    get:
      tags:
      - site-health
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SiteHealthDashboard'
      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: crawl_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 site health
      x-summary-source: derived
      operationId: getV1ProjectsByProjectIdSiteHealth
      x-operation-id-source: derived
components:
  schemas:
    CrawlOverallStatus:
      type: string
      enum:
      - draft
      - validating
      - queued
      - running
      - paused
      - completed
      - partially_completed
      - failed
      - cancelled
    SiteHealthDashboard:
      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)$
        crawl:
          anyOf:
          - $ref: '#/components/schemas/SiteCrawl'
          - type: 'null'
        score_summary:
          anyOf:
          - $ref: '#/components/schemas/SiteScoreSummary'
          - type: 'null'
        phase:
          type: string
          enum:
          - empty
          - discovering
          - analyzing
          - dashboard
          - terminal
        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'
        quota:
          $ref: '#/components/schemas/MonitoredQuota'
        root_errors:
          type: array
          items:
            $ref: '#/components/schemas/RootError'
      required:
      - project_id
      - crawl
      - score_summary
      - phase
      - snapshot_id
      - quota
      - root_errors
      additionalProperties: false
    CrawlDiscoveryStatus:
      type: string
      enum:
      - pending
      - running
      - stopped
      - completed
      - sample_completed
      - failed
      - cancelled
    PageKindScoreSummary:
      type: object
      properties:
        analyzed_count:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        web_fundamentals_score:
          type:
          - number
          - 'null'
        web_fundamentals_coverage:
          type:
          - number
          - 'null'
        web_fundamentals_state:
          type: string
          enum:
          - measured
          - limited_evidence
          - not_measured
          - excluded
        aeo_readiness_score:
          type:
          - number
          - 'null'
        aeo_measurement_coverage:
          type:
          - number
          - 'null'
        aeo_measurement_state:
          type: string
          enum:
          - measured
          - limited_evidence
          - not_measured
          - excluded
        aeo_measurement_reason:
          type: string
      required:
      - analyzed_count
      - web_fundamentals_score
      - web_fundamentals_coverage
      - web_fundamentals_state
      - aeo_readiness_score
      - aeo_measurement_coverage
      - aeo_measurement_state
      - aeo_measurement_reason
      additionalProperties: false
    CrawlCounters:
      type: object
      properties:
        discovered:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
        selected:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        queued:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        running:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        analyzed:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        errors:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        blocked:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        failure_breakdown:
          type: object
          properties:
            robots_denied:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            http_4xx:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            http_5xx:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            timeout:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
          required:
          - robots_denied
          - http_4xx
          - http_5xx
          - timeout
          additionalProperties: false
        activity:
          type: object
          properties:
            state:
              type: string
              enum:
              - working
              - waiting
              - stalled
              - terminal
            reason:
              type: string
              enum:
              - active_work
              - host_gate
              - retry_backoff
              - expired_lease
              - terminal
            queue_depth:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            next_available_at:
              type:
              - string
              - 'null'
          required:
          - state
          - reason
          - queue_depth
          - next_available_at
          additionalProperties: false
        by_page_kind:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
      required:
      - discovered
      - selected
      - queued
      - running
      - analyzed
      - errors
      - blocked
      - failure_breakdown
      - activity
      - by_page_kind
      additionalProperties: false
    RootError:
      type: object
      properties:
        method:
          type: string
        target:
          type: string
        outcome:
          type: string
        error_code:
          type: string
        status_code:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
        latency_ms:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
      required:
      - method
      - target
      - outcome
      - error_code
      - status_code
      - latency_ms
      additionalProperties: false
    CrawlAnalysisStatus:
      type: string
      enum:
      - pending
      - running
      - stopped
      - completed
      - partially_completed
      - failed
      - cancelled
    MonitoredQuota:
      type: object
      properties:
        used:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        limit:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
      required:
      - used
      - limit
      additionalProperties: false
    SiteScoreSummary:
      type: object
      properties:
        web_fundamentals_score:
          type:
          - number
          - 'null'
        web_fundamentals_coverage:
          type:
          - number
          - 'null'
        web_fundamentals_state:
          type: string
          enum:
          - measured
          - limited_evidence
          - not_measured
          - excluded
        aeo_readiness_score:
          type:
          - number
          - 'null'
        aeo_measurement_coverage:
          type:
          - number
          - 'null'
        aeo_measurement_state:
          type: string
          enum:
          - measured
          - limited_evidence
          - not_measured
          - excluded
        search_eligibility:
          type: string
          enum:
          - eligible
          - blocked
          - unknown
          - excluded
        classified_page_count:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        other_page_count:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        classification_error_page_count:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        classification_expected_page_count:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        classification_coverage:
          anyOf:
          - type: number
            minimum: 0
            maximum: 1
          - type: 'null'
        classification_state:
          type: string
          enum:
          - complete
          - partial
          - not_measured
        classification_reason_groups:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            type: integer
            minimum: 0
            maximum: 9007199254740991
        classification_formula_version:
          type: string
        scored_page_kind_set:
          type: array
          items:
            $ref: '#/components/schemas/PageKind'
        scored_page_count_by_kind:
          type: object
          propertyNames:
            $ref: '#/components/schemas/PageKind'
          additionalProperties:
            type: integer
            minimum: 0
            maximum: 9007199254740991
        selected_count:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        analyzed_count:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        issue_count:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        scoring_version:
          type: string
        by_page_kind:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            $ref: '#/components/schemas/PageKindScoreSummary'
      required:
      - web_fundamentals_score
      - web_fundamentals_coverage
      - web_fundamentals_state
      - aeo_readiness_score
      - aeo_measurement_coverage
      - aeo_measurement_state
      - search_eligibility
      - classified_page_count
      - other_page_count
      - classification_error_page_count
      - classification_expected_page_count
      - classification_coverage
      - classification_state
      - classification_reason_groups
      - classification_formula_version
      - scored_page_kind_set
      - scored_page_count_by_kind
      - selected_count
      - analyzed_count
      - issue_count
      - scoring_version
      - by_page_kind
      additionalProperties: false
    PageKind:
      type: string
      enum:
      - homepage
      - article
      - editorial_index
      - product
      - category
      - pricing
      - docs
      - faq
      - about_contact
      - service
      - local
      - guide
      - how_to
      - listicle
      - comparison
      - alternative
      - case_study_review
      - trust_policy
      - other
    SiteCrawl:
      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)$
        workspace_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)$
        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)$
        profile_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:
          $ref: '#/components/schemas/CrawlOverallStatus'
        discovery_status:
          $ref: '#/components/schemas/CrawlDiscoveryStatus'
        analysis_status:
          $ref: '#/components/schemas/CrawlAnalysisStatus'
        root_url:
          type: string
        sample_mode:
          type: boolean
        seed:
          type: string
        inventory_complete:
          type: boolean
        partial_reason:
          type: string
          enum:
          - ''
          - discovery_incomplete
          - analysis_incomplete
          - discovery_and_analysis_incomplete
        visible_url_count:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        analyzed_count:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        failed_count:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        discovery_requested_count:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        analysis_requested_count:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        counters:
          $ref: '#/components/schemas/CrawlCounters'
        discovered_count:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
        total_url_count:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
        has_more_site_urls:
          type:
          - boolean
          - 'null'
        score_summary:
          anyOf:
          - $ref: '#/components/schemas/SiteScoreSummary'
          - type: 'null'
        failure_summary:
          anyOf:
          - type: object
            properties:
              code:
                type: string
              message:
                type: string
              attempts:
                anyOf:
                - type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                - type: 'null'
              status_code:
                anyOf:
                - type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                - type: 'null'
              target_url:
                type: string
            required:
            - code
            - message
            - attempts
            - status_code
            - target_url
            additionalProperties: false
          - type: 'null'
        site_facts:
          anyOf:
          - type: object
            propertyNames:
              type: string
            additionalProperties: {}
          - type: 'null'
        extractor_version:
          type: string
        analyzer_version:
          type: string
        rule_version:
          type: string
        scoring_version:
          type: string
        error_message:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
        started_at:
          type:
          - string
          - 'null'
        completed_at:
          type:
          - string
          - 'null'
      required:
      - id
      - workspace_id
      - project_id
      - profile_id
      - status
      - discovery_status
      - analysis_status
      - root_url
      - sample_mode
      - seed
      - inventory_complete
      - partial_reason
      - visible_url_count
      - analyzed_count
      - failed_count
      - discovery_requested_count
      - analysis_requested_count
      - counters
      - total_url_count
      - score_summary
      - failure_summary
      - site_facts
      - extractor_version
      - analyzer_version
      - rule_version
      - scoring_version
      - error_message
      - created_at
      - updated_at
      - started_at
      - completed_at
      additionalProperties: false
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'An API key created in Settings → API keys, sent as `Authorization: Bearer cl_live_…`.'