CiteLadder

CiteLadder Audit Schedules API

The audit-schedules API from CiteLadder — 2 operation(s) for audit-schedules.

GitHub OpenAPI

Operations 5

POST /v1/projects/{project_id}/audit-schedules Create projects by project id audit schedules #
GET /v1/projects/{project_id}/audit-schedules Get projects by project id audit schedules #
GET /v1/projects/{project_id}/audit-schedules/{schedule_id} Get projects by project id audit schedules by schedule id #
PATCH /v1/projects/{project_id}/audit-schedules/{schedule_id} Update projects by project id audit schedules by schedule id #
DELETE /v1/projects/{project_id}/audit-schedules/{schedule_id} Delete projects by project id audit schedules by schedule id #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/citeladder-com/openapi/citeladder-com-audit-schedules-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-audit-schedules-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-audit-schedules-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: CiteLadder Audit Schedules API
  version: '1'
servers:
- url: https://api.citeladder.com
security:
- apiKey: []
tags:
- name: audit-schedules
paths:
  /v1/projects/{project_id}/audit-schedules:
    post:
      tags:
      - audit-schedules
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditSchedule'
      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: Idempotency-Key
        in: header
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                prompt_set_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)$
                audit_scope:
                  default: brand
                  type: string
                  enum:
                  - brand
                  - commerce
                cadence:
                  $ref: '#/components/schemas/AuditScheduleCadence'
                interval_minutes:
                  default: null
                  anyOf:
                  - type: integer
                    exclusiveMinimum: 0
                    maximum: 2147483647
                  - type: 'null'
                timezone:
                  type: string
                  minLength: 1
                  maxLength: 64
                engines:
                  minItems: 1
                  type: array
                  items:
                    $ref: '#/components/schemas/LogicalEngine'
                market_ids:
                  default:
                  - null
                  minItems: 1
                  maxItems: 11
                  type: array
                  items:
                    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'
                repetitions:
                  default: null
                  anyOf:
                  - type: integer
                    minimum: 1
                    maximum: 10
                  - type: 'null'
                benchmark_mode:
                  default: null
                  anyOf:
                  - $ref: '#/components/schemas/BenchmarkMode'
                  - type: 'null'
                enabled:
                  default: true
                  type: boolean
                next_run_at:
                  default: null
                  anyOf:
                  - type: string
                    format: date-time
                    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])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                  - type: 'null'
              required:
              - prompt_set_id
              - cadence
              - engines
      x-citeladder-scope: schedules:write
      summary: Create projects by project id audit schedules
      x-summary-source: derived
      operationId: postV1ProjectsByProjectIdAuditSchedules
      x-operation-id-source: derived
    get:
      tags:
      - audit-schedules
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AuditSchedule'
      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)$
      x-citeladder-scope: read
      summary: Get projects by project id audit schedules
      x-summary-source: derived
      operationId: getV1ProjectsByProjectIdAuditSchedules
      x-operation-id-source: derived
  /v1/projects/{project_id}/audit-schedules/{schedule_id}:
    get:
      tags:
      - audit-schedules
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditSchedule'
      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: schedule_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)$
      x-citeladder-scope: read
      summary: Get projects by project id audit schedules by schedule id
      x-summary-source: derived
      operationId: getV1ProjectsByProjectIdAuditSchedulesByScheduleId
      x-operation-id-source: derived
    patch:
      tags:
      - audit-schedules
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditSchedule'
      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: schedule_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)$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                prompt_set_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)$
                audit_scope:
                  type: string
                  enum:
                  - brand
                  - commerce
                cadence:
                  $ref: '#/components/schemas/AuditScheduleCadence'
                interval_minutes:
                  anyOf:
                  - type: integer
                    exclusiveMinimum: 0
                    maximum: 2147483647
                  - type: 'null'
                timezone:
                  type: string
                  minLength: 1
                  maxLength: 64
                engines:
                  minItems: 1
                  type: array
                  items:
                    $ref: '#/components/schemas/LogicalEngine'
                market_ids:
                  minItems: 1
                  maxItems: 11
                  type: array
                  items:
                    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'
                repetitions:
                  anyOf:
                  - type: integer
                    minimum: 1
                    maximum: 10
                  - type: 'null'
                benchmark_mode:
                  anyOf:
                  - $ref: '#/components/schemas/BenchmarkMode'
                  - type: 'null'
                enabled:
                  type: boolean
                next_run_at:
                  anyOf:
                  - type: string
                    format: date-time
                    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])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                  - type: 'null'
      x-citeladder-scope: schedules:write
      summary: Update projects by project id audit schedules by schedule id
      x-summary-source: derived
      operationId: patchV1ProjectsByProjectIdAuditSchedulesByScheduleId
      x-operation-id-source: derived
    delete:
      tags:
      - audit-schedules
      responses:
        '204':
          description: Successful Response
      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: schedule_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)$
      x-citeladder-scope: schedules:write
      summary: Delete projects by project id audit schedules by schedule id
      x-summary-source: derived
      operationId: deleteV1ProjectsByProjectIdAuditSchedulesByScheduleId
      x-operation-id-source: derived
components:
  schemas:
    BenchmarkMode:
      type: string
      enum:
      - consumer_like
      - controlled_localized
      - forced_grounded
    AuditScheduleCadence:
      type: string
      enum:
      - one_time
      - every_n_minutes
      - hourly
      - daily
      - weekly
    LogicalEngine:
      type: string
      enum:
      - chatgpt
      - gemini
      - claude
      - google_ai_overview
      - chatgpt_search
      - gemini_consumer
    AuditSchedule:
      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)$
        prompt_set_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)$
        audit_scope:
          type: string
          enum:
          - brand
          - commerce
        cadence:
          $ref: '#/components/schemas/AuditScheduleCadence'
        interval_minutes:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
        timezone:
          type: string
        engines:
          type: array
          items:
            $ref: '#/components/schemas/LogicalEngine'
        market_ids:
          type: array
          items:
            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'
        repetitions:
          anyOf:
          - type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          - type: 'null'
        benchmark_mode:
          anyOf:
          - $ref: '#/components/schemas/BenchmarkMode'
          - type: 'null'
        enabled:
          type: boolean
        next_run_at:
          type:
          - string
          - 'null'
        last_run_at:
          type:
          - string
          - 'null'
        failure_count:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        last_error:
          type: string
        last_failure_at:
          type:
          - string
          - 'null'
        created_at:
          type: string
        updated_at:
          type: string
      required:
      - id
      - workspace_id
      - project_id
      - prompt_set_id
      - audit_scope
      - cadence
      - interval_minutes
      - timezone
      - engines
      - market_ids
      - repetitions
      - benchmark_mode
      - enabled
      - next_run_at
      - last_run_at
      - failure_count
      - last_error
      - last_failure_at
      - created_at
      - updated_at
      additionalProperties: false
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'An API key created in Settings → API keys, sent as `Authorization: Bearer cl_live_…`.'