> ## Documentation Index > Fetch the complete documentation index at: https://docs.contraforce.com/llms.txt > Use this file to discover all available pages before exploring further. # Get reporting by workspace ## OpenAPI ````yaml /api-reference/openapi.json post /api/v2/reporting/by-workspace openapi: 3.1.1 info: title: ContraForce API description: ContraForce platform API for security operations management. version: '2.0' servers: [] security: [] tags: - name: Incidents - name: Gamebooks - name: Data sources - name: Service tickets - name: Investigation - name: Export - name: agent-tools - name: Cross-workspace incidents - name: Cross-workspace gamebooks - name: Cross-workspace data sources - name: Webhooks - name: Service accounts - name: Users - name: Azure resources - name: Reporting paths: /api/v2/reporting/by-workspace: post: tags: - Reporting summary: Get reporting by workspace operationId: v2-get-reporting-by-workspace requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportingByWorkspaceRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ApiResponseOfWorkspaceBreakdownResponse' '400': description: Bad request — validation or parameter binding failed. content: application/problem+json: schema: $ref: '#/components/schemas/ApiProblemDetails' '401': description: Unauthorized — missing or invalid Bearer token. content: application/problem+json: schema: $ref: '#/components/schemas/ApiProblemDetails' '403': description: Forbidden — insufficient scope or workspace access. content: application/problem+json: schema: $ref: '#/components/schemas/ApiProblemDetails' '404': description: Not found — workspace or resource is missing. content: application/problem+json: schema: $ref: '#/components/schemas/ApiProblemDetails' '500': description: Internal server error. content: application/problem+json: schema: $ref: '#/components/schemas/ApiProblemDetails' components: schemas: ReportingByWorkspaceRequest: required: - metric - from - to type: object properties: metric: type: - 'null' - string description: >- The metric to rank the workspaces by: `received`, `closed`, `investigated`, `actions`, `breached` or `atRisk`. top: pattern: ^-?(?:0|[1-9]\d*)$ type: - 'null' - integer - string description: >- How many workspaces to name before the remainder, from 1 to 10; 6 when omitted. format: int32 from: type: string description: >- The first day of the range, inclusive (UTC days). A range spans at most 366 days. format: date to: type: string description: The last day of the range, inclusive (UTC days). format: date workspaceIds: type: - 'null' - array items: type: string format: uuid description: >- The workspaces to read, at most 500; `null` or empty reads every workspace the caller may see. A service account sees the workspaces it holds a role on. description: One metric by workspace over the range. ApiResponseOfWorkspaceBreakdownResponse: type: object properties: data: $ref: '#/components/schemas/WorkspaceBreakdownResponse' description: >- v2 one reporting metric by workspace: the highest workspaces and a remainder. meta: $ref: '#/components/schemas/ResponseMeta' description: Standard v2 API response envelope for single-item responses. ApiProblemDetails: type: object properties: type: type: - 'null' - string title: type: - 'null' - string status: pattern: ^-?(?:0|[1-9]\d*)$ type: - 'null' - integer - string format: int32 detail: type: - 'null' - string instance: type: - 'null' - string code: type: - 'null' - string requestId: type: - 'null' - string timestamp: type: - 'null' - string target: type: - 'null' - string errors: type: - 'null' - object additionalProperties: type: array items: type: string description: >- API extension of ProblemDetails that surfaces the stable error code, trace identifier, timestamp, optional target, and optional field-keyed validation error map alongside the RFC 7807 members. WorkspaceBreakdownResponse: type: object properties: metric: type: - 'null' - string description: '`received`, `closed`, `investigated`, `actions` or `breached`.' total: pattern: ^-?(?:0|[1-9]\d*)$ type: - integer - string description: The metric over the whole selection, as its widget counts it. format: int32 workspaces: type: - 'null' - array items: $ref: '#/components/schemas/WorkspaceBreakdownRowResponse' description: One workspace's value in a WorkspaceBreakdownResponse. description: >- The workspaces with the highest value, highest first; none with a value of zero. remainder: pattern: ^-?(?:0|[1-9]\d*)$ type: - integer - string description: >- The total less the listed workspaces, so the breakdown adds up to int WorkspaceBreakdownResponse.Total. format: int32 otherWorkspaces: pattern: ^-?(?:0|[1-9]\d*)$ type: - integer - string description: Selected workspaces that are not listed. format: int32 read: $ref: '#/components/schemas/ReportingReadInfoResponse' description: How the response was read. description: >- v2 one reporting metric by workspace: the highest workspaces and a remainder. ResponseMeta: type: object properties: requestId: type: - 'null' - string timestamp: type: - 'null' - string WorkspaceBreakdownRowResponse: type: object properties: workspaceId: type: string format: uuid name: type: - 'null' - string description: The workspace's name, or `null` when it could not be read. value: pattern: ^-?(?:0|[1-9]\d*)$ type: - integer - string format: int32 description: One workspace's value in a WorkspaceBreakdownResponse. ReportingReadInfoResponse: type: object properties: scope: type: - 'null' - string description: >- `account` when account-wide totals were read, otherwise `workspaces`. workspaceCount: pattern: ^-?(?:0|[1-9]\d*)$ type: - integer - string description: Workspaces the response covers. format: int32 documentsRead: pattern: ^-?(?:0|[1-9]\d*)$ type: - integer - string description: >- Aggregate documents read to build the response (0 when served from cache). format: int32 fromCache: type: boolean description: Whether the response came from the in-memory cache. authorizeMs: pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$ type: - number - string description: >- Milliseconds this request spent validating the range and checking workspace access. format: double readMs: pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$ type: - number - string description: >- Milliseconds spent loading aggregate documents (0 when served from cache). format: double description: How a reporting response was read, for load testing and diagnosis. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.