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

# Get a probe test result

> Returns 202 while the agent has not answered, then the same result testProbe returns. Results are kept for about a day. A key with write:metrics or write:config may call it; jobs of other organizations return 404.



## OpenAPI

````yaml api-reference/openapi.json GET /metrics/test/{job_id}
openapi: 3.1.0
info:
  title: Observer API
  version: 1.0.0
  description: >-
    Public API for Observer: read services, metrics, SLOs and SLA statements;
    manage incidents, maintenance windows, manual metric status, config as code
    and Observer Agents. Bearer-auth via API keys (obs_pub_…), scoped per key.
    RFC 7807 problem-detail errors. Cursor pagination. Rate limits are per
    organization. Every date-time value is RFC 3339 in UTC with millisecond
    precision (`2026-01-31T12:00:00.000Z`).
servers:
  - url: https://use.observer/api/v1
security:
  - bearerAuth: []
paths:
  /metrics/test/{job_id}:
    parameters:
      - name: job_id
        in: path
        required: true
        description: job_id from a 202 testProbe response.
        schema:
          type: string
          format: uuid
    get:
      tags:
        - metrics
      summary: >-
        Get the result of a probe test that was still running (testProbe
        returned 202)
      description: >-
        Returns 202 while the agent has not answered, then the same result
        testProbe returns. Results are kept for about a day. A key with
        write:metrics or write:config may call it; jobs of other organizations
        return 404.
      operationId: getProbeTest
      responses:
        '200':
          description: the probe ran
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProbeTestResult'
          headers:
            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'
            X-RateLimit-Daily-Limit:
              $ref: '#/components/headers/X-RateLimit-Daily-Limit'
            X-RateLimit-Daily-Remaining:
              $ref: '#/components/headers/X-RateLimit-Daily-Remaining'
            X-RateLimit-Daily-Reset:
              $ref: '#/components/headers/X-RateLimit-Daily-Reset'
        '202':
          description: still waiting for the agent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProbeTestPending'
          headers:
            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'
            X-RateLimit-Daily-Limit:
              $ref: '#/components/headers/X-RateLimit-Daily-Limit'
            X-RateLimit-Daily-Remaining:
              $ref: '#/components/headers/X-RateLimit-Daily-Remaining'
            X-RateLimit-Daily-Reset:
              $ref: '#/components/headers/X-RateLimit-Daily-Reset'
        '401':
          description: >-
            `unauthenticated`: no bearer token was sent, or the key is invalid
            or revoked. `detail` distinguishes the two.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: >-
            `forbidden`: the key holds neither `write:metrics` nor
            `write:config`. `plan_does_not_permit_api`: the plan does not
            include the public API.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: >-
            `not_found`: no probe test with that id is available to this key.
            One owned by another organization, or an id that is not a valid
            UUID, returns the same response, so a 404 does not confirm that the
            id is unused.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: >-
            `rate_limited`: the organization's per-minute or daily request limit
            is used up (`limit.window` says which). Limits are per organization,
            shared by every key. The response carries `Retry-After` and
            `retry_after`, in seconds.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          headers:
            Retry-After:
              $ref: '#/components/headers/Retry-After'
            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'
            X-RateLimit-Daily-Limit:
              $ref: '#/components/headers/X-RateLimit-Daily-Limit'
            X-RateLimit-Daily-Remaining:
              $ref: '#/components/headers/X-RateLimit-Daily-Remaining'
            X-RateLimit-Daily-Reset:
              $ref: '#/components/headers/X-RateLimit-Daily-Reset'
        '500':
          description: '`internal_error`: an unhandled server error. Safe to retry.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '502':
          description: >-
            `probe_test_failed`: the agent could not run the test (`reason` is
            its error code).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '504':
          description: '`probe_test_expired`: the agent did not answer within 2 minutes.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
        - bearerAuth:
            - write:metrics
        - bearerAuth:
            - write:config
components:
  schemas:
    ProbeTestResult:
      type: object
      required:
        - value
        - unit
        - status
        - duration_ms
        - mode
      properties:
        value:
          type:
            - number
            - 'null'
          description: >-
            What the probe measured, in `unit`. null when it got no value (see
            reason).
        unit:
          type:
            - string
            - 'null'
          description: >-
            Unit of value (ms, %, days, s, B/s), or null for a bare number. Same
            rules as a metric's unit.
        value_description:
          type:
            - string
            - 'null'
          description: What the value is, in words.
        status:
          type:
            - string
            - 'null'
          enum:
            - healthy
            - degraded
            - unhealthy
            - no_data
            - null
          description: >-
            The status these thresholds give the value; no_data when the probe
            got no value. null when a value was measured but thresholds were not
            all given.
        reason:
          type:
            - string
            - 'null'
          description: >-
            Why there is no value: the agent's reason code (e.g. ETIMEDOUT,
            unexpected_status:503). null on success.
        reason_label:
          type:
            - string
            - 'null'
          description: Short human description of `reason`.
        reason_hint:
          type:
            - string
            - 'null'
          description: What usually causes `reason` and how to fix it.
        duration_ms:
          type: integer
          description: How long the probe took, in milliseconds.
        mode:
          type: string
          enum:
            - agent
            - cloud
          description: >-
            agent: ran on the agent's network with its secrets. cloud: a public
            HTTP check run from Observer's cloud.
        job_id:
          type:
            - string
            - 'null'
          format: uuid
          description: The agent job (agent mode only).
        agent_id:
          type:
            - string
            - 'null'
          format: uuid
        thresholds_complete:
          type: boolean
        skipped_secret_headers:
          type: array
          items:
            type: string
          description: >-
            Cloud mode only: header_refs names that were not sent, because their
            values live on an agent host.
    ProbeTestPending:
      type: object
      required:
        - job_id
        - status
        - poll
      properties:
        job_id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - pending
            - running
        agent_id:
          type: string
          format: uuid
        expires_at:
          type: string
          format: date-time
          description: The agent must answer by then (2 minutes after the POST).
        poll:
          type: string
          description: Path to GET for the result (getProbeTest).
        detail:
          type: string
    Problem:
      type: object
      required:
        - type
        - title
        - status
      example:
        type: https://docs.use.observer/api/getting-started/errors#forbidden
        title: forbidden
        status: 403
        detail: 'missing scope: write:incidents'
      properties:
        type:
          type: string
          format: uri
          description: Errors reference URI with the title token as the fragment.
          example: https://docs.use.observer/api/getting-started/errors#forbidden
        title:
          type: string
          description: Stable error token. Branch on this, not on detail.
        status:
          type: integer
        detail:
          type: string
          description: Human-readable explanation. Wording may change.
        retry_after:
          type: integer
          description: >-
            429 only: seconds until the exhausted window resets (mirrors
            Retry-After).
        limit:
          type: object
          description: '429 only: which organization limit was hit.'
          properties:
            scope:
              type: string
              enum:
                - organization
            window:
              type: string
              enum:
                - minute
                - day
            max:
              type: integer
            plan:
              type: string
        errors:
          type: array
          description: >-
            Validation failures (config_invalid, invalid_customer_targeting):
            one entry per problem.
          items:
            type: object
            properties:
              path:
                type: string
              message:
                type: string
        warnings:
          type: array
          description: >-
            config_invalid only: the same non-fatal warnings a successful apply
            returns.
          items:
            type: object
            properties:
              path:
                type: string
              message:
                type: string
        unknown_customers:
          type: array
          description: >-
            unknown_customers only: the submitted values that matched no
            customer in your organization.
          items:
            type: string
        unknown_services:
          type: array
          description: >-
            unknown_services only: the submitted `affected_services` values that
            matched no service in your organization.
          items: {}
        referenced_by:
          type: object
          description: >-
            in_use only: what depends on the object (slos, pages: lists of { id,
            config_key, name }; subscribers: a count).
        quota:
          type: object
          description: >-
            quota_exceeded / feature_locked on a create, item_suspended_plan on
            a write to a suspended item: the plan limit involved.
          properties:
            capability:
              type: string
            used:
              type:
                - integer
                - 'null'
            cap:
              type:
                - integer
                - 'null'
            plan:
              type:
                - string
                - 'null'
        upgrade:
          type: object
          description: >-
            Plan-limit problems only, when a higher plan lifts the limit: the
            smallest such plan and the pricing page.
          properties:
            plan:
              type: string
            label:
              type: string
            url:
              type: string
              format: uri
  headers:
    X-RateLimit-Limit:
      description: Requests allowed per minute for the organization.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests left in the current minute.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Seconds until the per-minute window resets.
      schema:
        type: integer
    X-RateLimit-Daily-Limit:
      description: Requests allowed per UTC day for the organization.
      schema:
        type: integer
    X-RateLimit-Daily-Remaining:
      description: Requests left today (UTC).
      schema:
        type: integer
    X-RateLimit-Daily-Reset:
      description: Seconds until the daily quota resets (UTC midnight).
      schema:
        type: integer
    Retry-After:
      description: '429 only: seconds to wait before retrying.'
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: obs_pub_
      description: >-
        An organization API key (obs_pub_…) sent as `Authorization: Bearer
        <key>`. Each key carries scopes; an endpoint lists the scope it needs.
        `read:change_events` is reserved: keys can carry it, but no endpoint
        needs it yet.

````

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