---
search:
  tags:
    - organization-reads
    - POST
seo:
  description: >-
    Get report preparation status and summary. An organization-scoped read…
    Reference for the POST /queries/get_report endpoint in the Soljio
    Organization API.
sidebar:
  label: Get report preparation status and summary.
  badge: POST
title: Get report preparation status and summary.
type: openapi-operation
---
Get report preparation status and summary. An organization-scoped read using JSON filter arguments; requires reports.read. Pagination cursors must be reused only with the same organization, operation and filters.

`POST /queries/get_report`

**Request body** (`application/json`, required)

- `job_id` (string, required) — Opaque Soljio resource ID.

Request body example:

```json
{
  "job_id": "string"
}
```

**Responses**

- `200` — Successful read.
- `400` — invalid\_request
- `401` — unauthorized
- `403` — forbidden
- `404` — not\_found
- `405` — method\_not\_allowed
- `409` — conflict, idempotency\_conflict
- `413` — payload\_too\_large
- `415` — unsupported\_media\_type
- `429` — rate\_limited
- `500` — internal\_error

Response example, 200:

```json
{
  "data": {
    "completed_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "data_quality": {
      "has_attendance_data": true,
      "has_capacity_data": true,
      "has_payment_data": true,
      "has_session_data": true,
      "is_partial": true
    },
    "id": "string",
    "row_counts": {
      "attendance": 0,
      "capacity": 0,
      "revenue": 0
    },
    "source_changed": true,
    "status": "running",
    "summary": {
      "attendance": {
        "absent": 0,
        "attended": 0,
        "excused": 0,
        "late": 0,
        "missed": 0,
        "present": 0,
        "recorded": 0,
        "unrecorded": 0
      },
      "cancellations": {
        "enrollments": 0,
        "sessions": 0
      },
      "capacity": {
        "full": 0,
        "no_limit": 0,
        "over_capacity": 0,
        "sessions": 0,
        "under_filled": 0,
        "waitlisted": 0
      },
      "enrollments": {
        "canceled": 0,
        "completed": 0,
        "confirmed": 0,
        "pending": 0,
        "total": 0,
        "transferred": 0,
        "waitlisted": 0
      },
      "makeups": {
        "available": 0,
        "consumed": 0,
        "issued": 0
      },
      "payments": {
        "failed": 0,
        "not_required": 0,
        "overpaid": 0,
        "paid": 0,
        "partially_paid": 0,
        "partially_refunded": 0,
        "pending": 0,
        "refunded": 0,
        "unpaid": 0,
        "unrecorded": 0,
        "recorded": 0,
        "total": 0
      }
    }
  },
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"
}
```

Response example, 400:

```json
{
  "error": {
    "code": "invalid_request",
    "message": "The request is invalid."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 401:

```json
{
  "error": {
    "code": "unauthorized",
    "message": "A valid service token is required."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 403:

```json
{
  "error": {
    "code": "forbidden",
    "message": "The service token lacks a required scope."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 404:

```json
{
  "error": {
    "code": "not_found",
    "message": "The requested resource was not found."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 405:

```json
{
  "error": {
    "code": "method_not_allowed",
    "message": "The method is not supported for this resource."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 409:

```json
{
  "error": {
    "code": "conflict",
    "message": "The command conflicts with the current state."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 413:

```json
{
  "error": {
    "code": "payload_too_large",
    "message": "The request body exceeds the byte limit for this operation."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 415:

```json
{
  "error": {
    "code": "unsupported_media_type",
    "message": "Use application/json for command requests."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 429:

```json
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after the indicated delay."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 500:

```json
{
  "error": {
    "code": "internal_error",
    "message": "The request could not be completed."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```
