> ## Documentation Index > Fetch the complete documentation index at: https://docs.spreadjam.com/llms.txt > Use this file to discover all available pages before exploring further. # List visibility runs > The project's recent visibility scans, newest first, each with its trigger, status, timing and answers collected per platform. Send `X-Jam-Project` to pick a project. ## OpenAPI ````yaml https://api.spreadjam.com/openapi.json get /v1/visibility-runs openapi: 3.0.0 info: title: SpreadJam API version: 1.0.0 servers: - url: https://api.spreadjam.com security: [] tags: - name: Meta description: Identity and metadata about the authenticated key. - name: Keywords description: Keyword and topic visibility rankings. - name: API keys description: Manage the workspace's API keys. - name: Analytics description: AI-visibility analytics for the workspace. - name: Brand description: The workspace's brand profile and competitors. - name: Prompts description: Tracked GEO prompts and their cap state. - name: Visibility runs description: Run the AI-visibility scan now. - name: Credits description: The workspace's credit balance and recent charges. - name: Actions description: Recommended visibility actions and reporting them done. - name: Agent connect description: >- Sign a human up from an agent with one link, then receive an API key once they approve. No API key needed. - name: Pricing description: >- The plans an agent can choose for a human and their monthly prices. No API key needed. - name: Site changes description: >- Code changes Jam prepares for page edits and technical fixes: preview, open the pull request, discard. - name: Research description: >- The research that writes the Plan: its state, its latest report, and running it again. - name: Answers description: >- What each AI platform answered to the tracked prompts, with the sources it cited. - name: Projects description: The workspace's projects and the status of each one. - name: Billing description: The workspace's plan and the links where a person manages billing. - name: Webhooks description: >- HTTP destinations the workspace notifications are POSTed to, signed with a per-webhook secret. - name: Notifications description: >- Which notifications reach which channels (including webhooks), per event category. - name: Opportunities description: >- Article opportunities: the article pipeline behind the Plan's `new_page` actions, and requests to create content from them. - name: Planning description: Run automatic content planning now. - name: Content description: Content items, their drafts, and requests to rewrite them. - name: Revisions description: A content item's revisions. - name: Publishing description: Publishing content to destinations, now or on a schedule. - name: Deliveries description: A content item's delivery history. - name: Publications description: Where a content item is live. - name: Destinations description: Where content is published, its publishing policy, and its connection. paths: /v1/visibility-runs: get: tags: - Visibility runs summary: List visibility runs description: >- The project's recent visibility scans, newest first, each with its trigger, status, timing and answers collected per platform. Send `X-Jam-Project` to pick a project. operationId: list_visibility_runs parameters: - schema: type: integer minimum: 1 maximum: 50 default: 10 description: Maximum number of items to return (1–100). example: 20 required: false description: Maximum number of items to return (1–100). name: limit in: query - schema: type: string format: uuid description: The `pageInfo.nextCursor` of the previous page. required: false description: The `pageInfo.nextCursor` of the previous page. name: cursor in: query - schema: type: string format: uuid description: Legacy name for `cursor` (the `nextBefore` of the previous page). required: false description: Legacy name for `cursor` (the `nextBefore` of the previous page). name: before in: query responses: '200': description: The runs. content: application/json: schema: $ref: '#/components/schemas/VisibilityRunList' '400': description: >- Invalid request: a parameter or body field is wrong. `details` lists each problem with what is allowed. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: >- Missing, malformed or revoked API key (`Authorization: Bearer sk_…`). content: application/json: schema: $ref: '#/components/schemas/ApiError' '404': description: >- The resource, or the project the key or `X-Jam-Project` selects, does not exist in this workspace. content: application/json: schema: $ref: '#/components/schemas/ApiError' '429': description: >- `rate_limited` (per-key rate) or `too_many_concurrent` (expensive reads in flight); retry after `Retry-After` seconds. content: application/json: schema: $ref: '#/components/schemas/ApiError' security: - bearerAuth: [] components: schemas: VisibilityRunList: type: object properties: runs: type: array items: $ref: '#/components/schemas/VisibilityRunSummary' pageInfo: $ref: '#/components/schemas/PageInfo' nextBefore: type: string nullable: true description: >- Legacy: the same value as `pageInfo.nextCursor`, null on the last page. Prefer `pageInfo`. required: - runs - pageInfo - nextBefore ApiError: type: object required: - error - code properties: error: type: string description: What went wrong and how to fix the request. code: type: string description: >- Stable machine-readable code, e.g. invalid_request, unauthorized, rate_limited. requestId: type: string description: Echoes the X-Request-Id header; quote it to support. docs: type: string description: Where the error is explained. resolveUrl: type: string description: '402/403 plan errors: the dashboard page that resolves it.' details: type: array description: >- One entry per problem: path, message, and when known allowed, minimum, maximum, expected, received. items: type: object additionalProperties: true VisibilityRunSummary: type: object properties: id: type: string trigger: type: string description: >- `scheduler` for the scheduled scan, `real_user_manual_scan` for a scan run now (dashboard or API), `bootstrap` for the first scan. status: type: string description: >- queued, running, retry_scheduled, finishing, success, partial_success, failed, blocked, cancelled or skipped. `finishing`: every task is queued but `answers.pending` answers are still being collected; the status becomes final (and `finishedAt` is set) once none is pending. A finished run that asked nothing itself (an earlier scan today already covered its prompts) is `skipped`; one that recorded no answer is `failed`. `reason` says why. storedStatus: type: string description: >- The status the scan pipeline stored, before `status` was derived from the answers. reason: type: object nullable: true properties: code: type: string description: >- answers_pending (while `finishing`), earlier_scan_in_progress, already_measured_today, no_candidates, tasks_rejected, no_answers, platform_failures (each platform as failed of its `total`), or the error code of a failed run. message: type: string required: - code - message description: >- Why the run ended this way; null while running and for a clean success. createdAt: type: string format: date-time startedAt: type: string nullable: true format: date-time finishedAt: type: string nullable: true format: date-time description: When every answer settled; null while running or `finishing`. storedFinishedAt: type: string nullable: true format: date-time description: >- When the scan pipeline marked the run finished (its tasks queued), which can be before the last answer lands. errorCode: type: string nullable: true answers: $ref: '#/components/schemas/VisibilityRunAnswers' expectedTotal: type: integer nullable: true description: >- Prompt and platform pairs the run will ask, known up front: tracked prompts in scope times platforms. `answers.total` grows toward it while `queuing` is true, so use this for progress, not `answers.total`. queuing: type: boolean description: >- True while the run is still queuing its tasks; `answers.total` is not final until it is false. platforms: type: array items: type: object properties: platform: type: string total: type: integer description: Prompt and platform pairs the run asked. answered: type: integer failed: type: integer description: >- No usable answer: provider error, timeout, rate limit, block or empty answer. skipped: type: integer pending: type: integer description: >- Still being collected. The run status is `finishing` until this is 0. failureRate: type: number nullable: true description: >- 0-1 share of settled answers (answered + failed) that failed; null when none settled. errors: type: array items: type: object properties: code: type: string description: >- The provider's error code, or the answer status (timeout, rate_limited, …) when it sent none. count: type: integer message: type: string nullable: true description: One stored error message for this code. required: - code - count - message description: Failures by error code, most frequent first. required: - platform - total - answered - failed - skipped - pending - failureRate - errors description: The same counts per platform, with the failure rate and error codes. required: - id - trigger - status - storedStatus - reason - createdAt - startedAt - finishedAt - storedFinishedAt - errorCode - answers - expectedTotal - queuing - platforms PageInfo: type: object properties: limit: type: integer description: The page size used. example: 100 hasNextPage: type: boolean nextCursor: type: string description: >- Pass as `cursor`, with the same filters, for the next page. Absent on the last page. totalCount: type: integer description: Matching items across every page. required: - limit - hasNextPage - totalCount VisibilityRunAnswers: type: object properties: total: type: integer description: Prompt and platform pairs the run asked. answered: type: integer failed: type: integer description: >- No usable answer: provider error, timeout, rate limit, block or empty answer. skipped: type: integer pending: type: integer description: >- Still being collected. The run status is `finishing` until this is 0. required: - total - answered - failed - skipped - pending securitySchemes: bearerAuth: type: http scheme: bearer description: >- A workspace API key issued in Settings → Developer, sent as `Bearer sk_…`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.