> ## Documentation Index > Fetch the complete documentation index at: https://chatobserver.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get an operation > Execute, validate, cancel and inspect operations and page through result rows. Required scopes: `metrics:read`. ## OpenAPI ````yaml GET /api/v2/metrics/operations/{operationId} openapi: 3.1.1 info: title: chatobserver public API version: '2026-09-09' description: >- Track AI visibility, manage prompts, inspect collected answers and citations, and integrate workspace data with your own tools. Visibility endpoints use workspace API keys. Data endpoints use scoped service-account keys; spreadsheet client endpoints use authorised client sessions. See the authentication guide for each credential type. contact: name: chatobserver support url: https://chatobserver.com/contact email: support@chatobserver.com servers: - url: https://app.chatobserver.com description: Production API security: - WorkspaceKey: [] - BearerKey: [] tags: - name: Workspace description: Validate access and list the workspace project and available platforms. - name: Prompts description: Create, schedule, organise, activate and retrieve tracked prompts. - name: Answers description: Retrieve collected AI answers, their analysis and visibility trends. - name: Brands description: Manage brands and compare their visibility in AI answers. - name: Sources and citations description: Analyse cited domains, pages and ownership across answers. - name: Visitor analytics description: Read website visitor and crawler analytics for the workspace. - name: Content opportunities description: Retrieve content-gap findings and recommendations for tracked prompts. - name: Usage description: Read workspace consumption and allowance summaries. - name: Data connections description: Discover authorised connections, source accounts and connector catalogues. - name: Data queries description: >- Create versioned queries, publish definitions and inspect integration contracts. - name: Data operations description: >- Execute, validate, cancel and inspect operations and page through result rows. - name: Data delivery description: Manage schedules, transfers, destinations and import workflows. - name: Data definitions description: Manage reusable definitions and their immutable versions. - name: Data webhooks description: >- Configure event delivery, inspect deliveries, replay events and rotate secrets. - name: Client authorisation description: Authorise spreadsheet clients using a user-approved challenge exchange. - name: Spreadsheet clients description: >- Access document-bound client sessions, queries, schedules, bindings and write claims. - name: AI visibility audits description: Create website visibility audits and retrieve their report links. - name: Version 1 description: Integrate with the version 1 visibility and analytics endpoints. paths: /api/v2/metrics/operations/{operationId}: get: tags: - Data operations summary: Get an operation description: >- Execute, validate, cancel and inspect operations and page through result rows. Required scopes: `metrics:read`. operationId: getV2MetricsOperationsOperationId parameters: - name: operationId in: path required: true schema: type: string format: uuid description: Resource identifier returned by the API. responses: '200': description: Successful response. content: application/json: schema: $ref: >- #/components/schemas/getV2MetricsOperationsOperationIdResponse200 default: description: >- Request failed. Inspect the error code and request identifier; retry only when the failure is retryable. content: application/json: schema: anyOf: - $ref: '#/components/schemas/DataError' - $ref: '#/components/schemas/ApiError' components: schemas: getV2MetricsOperationsOperationIdResponse200: type: object properties: data: type: object properties: operation: type: object properties: id: type: string action: type: string status: type: string resourceType: type: string resourceId: anyOf: - type: 'null' - type: string resourceVersionId: anyOf: - type: 'null' - type: string clientInvocation: anyOf: - type: 'null' - type: object properties: clientKind: enum: - looker_studio - power_bi - qlik - azure_data_factory - alteryx - n8n - tableau - generic_rest type: string consumerReferenceHash: type: string clientBindingVersionId: anyOf: - type: 'null' - type: string selectedFieldIds: type: array items: type: string requestedAt: type: string required: - clientKind - consumerReferenceHash - clientBindingVersionId - selectedFieldIds - requestedAt errorCode: anyOf: - type: 'null' - type: string cancelRequestedAt: anyOf: - type: 'null' - type: string startedAt: anyOf: - type: 'null' - type: string finishedAt: anyOf: - type: 'null' - type: string createdAt: type: string required: - id - action - status - resourceType - resourceId - resourceVersionId - clientInvocation - errorCode - cancelRequestedAt - startedAt - finishedAt - createdAt run: anyOf: - type: 'null' - type: object properties: id: type: string scheduleId: anyOf: - type: 'null' - type: string trigger: enum: - manual - preview - report_refresh - surface_refresh - scheduled - backfill type: string status: enum: - queued - running - succeeded - failed - pending - succeeded_with_warnings - canceled - cancelled type: string errorCode: anyOf: - type: 'null' - type: string rowCount: anyOf: - type: 'null' - type: number resultBytes: anyOf: - type: 'null' - type: number startedAt: anyOf: - type: 'null' - type: string finishedAt: anyOf: - type: 'null' - type: string createdAt: type: string stages: type: array items: type: object properties: startedAt: anyOf: - type: 'null' - type: string finishedAt: anyOf: - type: 'null' - type: string qualityResults: type: array items: type: object properties: assertionId: type: string severity: type: string passed: anyOf: - type: boolean const: false - type: boolean const: true failureCount: type: number evaluatedAt: type: string required: - assertionId - severity - passed - failureCount - evaluatedAt id: type: string kind: type: string position: type: number status: type: string rowsProcessed: type: number bytesProcessed: type: number errorCode: anyOf: - type: 'null' - type: string required: - startedAt - finishedAt - qualityResults - id - kind - position - status - rowsProcessed - bytesProcessed - errorCode required: - id - scheduleId - trigger - status - errorCode - rowCount - resultBytes - startedAt - finishedAt - createdAt - stages result: anyOf: - type: 'null' - type: object properties: artifactId: type: string schemaFingerprint: type: string rowCount: type: number byteCount: type: number expiresAt: type: string finalizedAt: anyOf: - type: 'null' - type: string required: - artifactId - schemaFingerprint - rowCount - byteCount - expiresAt - finalizedAt required: - operation - run - result required: - data DataError: type: object properties: error: type: object properties: code: enum: - internal - validation_failed - authentication_required - forbidden - not_found - conflict - precondition_failed - idempotency_conflict - capability_unavailable - connection_unavailable - reauthentication_required - provider_rate_limited - workspace_limit_exceeded - result_expired - operation_failed - temporarily_unavailable type: string fieldPath: type: array items: anyOf: - type: string - type: number parameters: type: object properties: {} additionalProperties: anyOf: - type: 'null' - type: string - type: number - type: boolean const: false - type: boolean const: true repairActions: type: array items: type: string minLength: 1 maxLength: 96 maxItems: 10 requestId: type: string minLength: 1 maxLength: 160 retryable: anyOf: - type: boolean const: false - type: boolean const: true retryAfterSeconds: anyOf: - type: 'null' - type: integer exclusiveMinimum: 0 required: - code - fieldPath - parameters - repairActions - requestId - retryable - retryAfterSeconds additionalProperties: false required: - error additionalProperties: false ApiError: type: object properties: error: type: object properties: code: type: string message: type: string details: {} required: - code - message requestId: type: string required: - error - requestId securitySchemes: WorkspaceKey: type: apiKey in: header name: x-chatobserver-key description: >- A workspace API key. Data endpoints require a service-account key with the specified scopes. BearerKey: type: http scheme: bearer description: The workspace or service-account API key as a bearer token. ````