> ## Documentation Index
> Fetch the complete documentation index at: https://docs.devtune.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get an action spot check

> Returns an action's spot check, or spotCheck null before one starts: its status, when it was requested and completed, and one result per prompt and platform with whether the answer mentioned the brand, whether it cited the brand's site, and up to 20 of its citations. A platform that could not answer is failed with its errorCode, such as timeout when it took over 4 minutes; a failed result is final, and errorCode says why. A spot check is a single re-ask after the action went live, not a measurement; measured change is in Results. Requires the `actions.read` scope.



## OpenAPI

````yaml /openapi.json get /projects/{projectId}/actions/{actionId}/spot-check
openapi: 3.1.0
info:
  title: DevTune API
  version: 2.0.0
  description: >-
    API for programmatic access to your AI visibility data, webhook
    subscriptions, and automation workflows. Use this API to integrate DevTune
    data into CI/CD pipelines, BI tools, AI agents, and operational systems.
servers:
  - url: https://devtune.ai/api/v2
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Connection and usage
    description: >-
      The project a credential is bound to, its scopes and features, usage, and
      code-mode receipts.
  - name: Setup
    description: >-
      Brands, domains, brand terms, platforms, content sources and pausing a
      project.
  - name: Prompts and topics
    description: Tracked prompts, their topics, and prompt-set analysis.
  - name: Visibility
    description: >-
      Visibility metrics, AI answers, sentiment, competitive position and the
      project timeline.
  - name: Citations
    description: >-
      Citation statistics, the most-cited domains and pages, and cited lookalike
      sites.
  - name: Positioning
    description: How well AI answers match your positioning statements.
  - name: Accuracy
    description: Claims AI answers make about your brand, and contradictions.
  - name: Content gaps
    description: Topics, sources and brands where competitors are cited.
  - name: AI Traffic
    description: >-
      AI referrals, answer fetches, crawls, 404 Demand, Direct lift and Search
      Console totals.
  - name: Adoption
    description: npm downloads and GitHub stars for project domains.
  - name: Audit and pages
    description: Audit findings, Google eligibility, page metrics, and locked pages.
  - name: Actions
    description: Suggested and accepted work, briefs, drafts and pull requests.
  - name: Results
    description: Content changes, measured results and what works.
  - name: Agents
    description: Managed agents, their schedules and runs.
  - name: Dex
    description: Private Dex conversations, specialist handoffs and memory.
  - name: Agent Picks
    description: Agent Picks setup, tests, schedules and results.
  - name: Library and Knowledge
    description: Library items and the Knowledge Profile.
  - name: Webhooks
    description: Webhook subscriptions and signing secrets.
  - name: Agent registration
    description: Setup drafts for an unclaimed agent registration.
paths:
  /projects/{projectId}/actions/{actionId}/spot-check:
    get:
      tags:
        - Actions
      summary: Get an action spot check
      description: >-
        Returns an action's spot check, or spotCheck null before one starts: its
        status, when it was requested and completed, and one result per prompt
        and platform with whether the answer mentioned the brand, whether it
        cited the brand's site, and up to 20 of its citations. A platform that
        could not answer is failed with its errorCode, such as timeout when it
        took over 4 minutes; a failed result is final, and errorCode says why. A
        spot check is a single re-ask after the action went live, not a
        measurement; measured change is in Results. Requires the `actions.read`
        scope.
      operationId: getActionSpotCheck
      parameters:
        - name: projectId
          in: path
          required: true
          description: >-
            The project the credential is bound to. Read it from GET
            /connection.
          schema:
            type: string
            format: uuid
        - name: actionId
          in: path
          required: true
          description: The action
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: The action spot check
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ActionSpotCheckData'
                  meta:
                    $ref: '#/components/schemas/Meta'
                required:
                  - data
                  - meta
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/RateLimitExceededError'
      security:
        - bearerAuth: []
        - oauthBearer: []
components:
  schemas:
    ActionSpotCheckData:
      type: object
      additionalProperties: false
      required:
        - actionId
        - spotCheck
      properties:
        actionId:
          type: string
          format: uuid
        spotCheck:
          description: Null until a spot check starts.
          oneOf:
            - type: 'null'
            - type: object
              additionalProperties: false
              required:
                - completedAt
                - id
                - kind
                - requestedAt
                - results
                - status
              properties:
                id:
                  type: string
                  format: uuid
                kind:
                  type: string
                  enum:
                    - spot_check
                  description: >-
                    A spot check, not a measurement: its answers count toward no
                    Visibility, Results or measured window.
                status:
                  type: string
                  enum:
                    - running
                    - completed
                requestedAt:
                  type: string
                  format: date-time
                completedAt:
                  type:
                    - string
                    - 'null'
                  format: date-time
                results:
                  type: array
                  description: One result per prompt and platform, by prompt then platform.
                  items:
                    $ref: '#/components/schemas/ActionSpotCheckResult'
    Meta:
      type: object
      description: Sent beside data on every successful response that returns data.
      properties:
        timestamp:
          type: string
          format: date-time
          description: When the response was produced.
        projectId:
          type: string
          format: uuid
    ActionSpotCheckResult:
      type: object
      additionalProperties: false
      required:
        - checkedAt
        - citations
        - cited
        - errorCode
        - mentioned
        - platform
        - promptId
        - promptText
        - status
      properties:
        promptId:
          type: string
          format: uuid
        promptText:
          type: string
          description: >-
            The prompt as the spot check asked it, kept when the prompt is later
            edited or deleted.
        platform:
          type: string
        status:
          type: string
          enum:
            - pending
            - completed
            - failed
        mentioned:
          type:
            - boolean
            - 'null'
          description: >-
            The answer named the brand; null until the answer is in, and for a
            failed platform.
        cited:
          type:
            - boolean
            - 'null'
          description: >-
            The answer cited the brand's site: a source on any of the brand's
            own domains, at any path. Null until the answer is in, for a failed
            platform, and when the platform returned no sources, so whether it
            cited the site is unknown.
        citations:
          type: array
          maxItems: 20
          items:
            $ref: '#/components/schemas/ActionSpotCheckCitation'
        errorCode:
          type:
            - string
            - 'null'
          description: Why the platform failed, when it did. A failed result is final.
        checkedAt:
          type:
            - string
            - 'null'
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: string
          description: >-
            Machine-readable error code, such as bad_request, unauthorized,
            forbidden, not_found, conflict, payment_required,
            rate_limit_exceeded or internal_error. Some endpoints return their
            own codes, listed in their descriptions.
        message:
          type: string
          description: >-
            What went wrong, for a person to read. Do not parse it; use error
            and reason.
        reason:
          type: string
          description: >-
            Why the request was refused, for an error with more than one cause,
            such as a refused content-draft start.
        details:
          type: object
          additionalProperties: true
          description: >-
            Machine-readable facts about the failure or refusal, such as
            retryable or shortfall_credits.
          properties:
            retryable:
              type: boolean
              description: >-
                Read this field before retrying. Present on every 5xx and 429
                response: true when another attempt may succeed, false for a
                permanent refusal even on a 5xx. Other refusals may also provide
                this field.
            retryAfterSeconds:
              type: integer
              minimum: 1
              description: >-
                Seconds to wait when retryable is true on a 429 or 503 response,
                also sent in Retry-After. Uses the provider retry time or
                limiter reset when available; otherwise 60 seconds for 429 and
                GitHub throttles or 30 seconds for other 503 responses. GitHub
                secondary limits wait at least 60 seconds.
        status:
          type: integer
          description: The HTTP status code, repeated in the body.
      required:
        - error
        - message
        - status
    ActionSpotCheckCitation:
      type: object
      additionalProperties: false
      required:
        - cited
        - domain
        - own
        - position
        - title
        - url
      properties:
        url:
          type: string
        domain:
          type: string
        title:
          type:
            - string
            - 'null'
        position:
          type: integer
        cited:
          type: boolean
          description: >-
            The answer cited this source; false for a source the platform only
            retrieved.
        own:
          type: boolean
          description: The source is on one of the brand's own domains, at any path.
  responses:
    UnauthorizedError:
      description: >-
        The request has no valid credential: the Authorization header is missing
        or malformed, or the API key or OAuth token is invalid, expired or
        revoked. Send `Authorization: Bearer <API key>` with an active key, or
        sign in again to get a new OAuth token. See
        [Errors](/api-reference/errors).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ForbiddenError:
      description: >-
        The credential is valid but can't make this request. The message says
        which cause applies: the key or sign-in lacks the scope this endpoint
        requires (named in the message), it belongs to another project, the plan
        doesn't include API access or this feature, the project is paused (a
        paused project keeps only read scopes and setup.write), or the member a
        write acts as no longer has the role it needs. Read `GET
        /projects/{projectId}/connection` for the credential's current scopes
        and features, then use a key that has the scope, sign in again and
        approve it, or upgrade the plan. See [Errors](/api-reference/errors).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFoundError:
      description: >-
        The resource doesn't exist in this project, was deleted, or the
        credential can't see it. Check the IDs in the path, and that the
        projectId is the project the credential is bound to. See
        [Errors](/api-reference/errors).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimitExceededError:
      description: >-
        Too many requests from this credential in the current window. The
        request was refused before it took effect, so it is safe to retry: wait
        the seconds in Retry-After, then send it again. Endpoints that start
        agent runs have a stricter limit. See [Rate
        limits](/api-reference/rate-limits).
      headers:
        Retry-After:
          description: Seconds to wait before retrying a 429 or retryable 503 response.
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  headers:
    X-RateLimit-Limit:
      description: Maximum requests per window
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests remaining in current window
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Unix timestamp when the window resets
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key with dtk_live_ prefix. Obtain it from API Keys in the account
        sidebar. New keys start with all supported scopes selected for the
        chosen project, and you can narrow them to specific read/write scopes as
        needed.
    oauthBearer:
      type: http
      scheme: bearer
      description: >-
        Project-granted OAuth access token from the authorization server
        advertised at /.well-known/oauth-protected-resource/api/v2. Uses the
        same browser consent and current project permissions as MCP. Only
        operations explicitly listing oauthBearer accept these tokens.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.