Skip to content
Soljio Docs
Esc
↑↓navigate↵open⌘Jpreview

Get report preparation status and summary.

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
Authorization
AuthorizationBearer token (soljio_sk_<secret>) · headerrequired

Organization-scoped service token created by an owner/admin. Scope requirements are in x-required-scopes; these are service-token grants, not OAuth scopes. Revoked, expired, unknown and suspended-organization credentials all return 401.

Request body
requiredapplication/json
job_idstringrequired

Opaque Soljio resource ID.

min length 1
Responses
200

Successful read.

dataobjectrequired
Show properties
completed_atstring<date-time>
created_atstring<date-time>required
data_qualityobjectrequired
Show properties
has_attendance_databooleanrequired
has_capacity_databooleanrequired
has_payment_databooleanrequired
has_session_databooleanrequired
is_partialbooleanrequired
idstringrequired

Opaque Soljio resource ID.

min length 1
row_countsobjectrequired
Show properties
attendancenumberrequired
capacitynumberrequired
revenuenumberrequired
source_changedbooleanrequired
statusstringrequired
Show properties
Any of:
string
string
string
string
string
string
summaryobjectrequired
Show properties
attendanceobjectrequired
Show properties
absentnumberrequired
attendednumberrequired
excusednumberrequired
latenumberrequired
missednumberrequired
presentnumberrequired
recordednumberrequired
unrecordednumberrequired
cancellationsobjectrequired
Show properties
enrollmentsnumberrequired
sessionsnumberrequired
capacityobjectrequired
Show properties
fullnumberrequired
no_limitnumberrequired
over_capacitynumberrequired
sessionsnumberrequired
under_fillednumberrequired
waitlistednumberrequired
enrollmentsobjectrequired
Show properties
cancelednumberrequired
completednumberrequired
confirmednumberrequired
pendingnumberrequired
totalnumberrequired
transferrednumberrequired
waitlistednumberrequired
makeupsobjectrequired
Show properties
availablenumberrequired
consumednumberrequired
issuednumberrequired
paymentsobjectrequired
Show properties
failednumberrequired
not_requirednumberrequired
overpaidnumberrequired
paidnumberrequired
partially_paidnumberrequired
partially_refundednumberrequired
pendingnumberrequired
refundednumberrequired
unpaidnumberrequired
unrecordednumberrequired
recordednumberrequired
totalnumberrequired
request_idstring<uuid>required
400

invalid_request

errorobjectrequired
Show properties
codestringrequired
Allowed:invalid_request
messagestringrequired
request_idstring<uuid>required
401

unauthorized

errorobjectrequired
Show properties
codestringrequired
Allowed:unauthorized
messagestringrequired
request_idstring<uuid>required
403

forbidden

errorobjectrequired
Show properties
codestringrequired
Allowed:forbidden
messagestringrequired
request_idstring<uuid>required
404

not_found

errorobjectrequired
Show properties
codestringrequired
Allowed:not_found
messagestringrequired
request_idstring<uuid>required
405

method_not_allowed

errorobjectrequired
Show properties
codestringrequired
Allowed:method_not_allowed
messagestringrequired
request_idstring<uuid>required
409

conflict, idempotency_conflict

errorobjectrequired
Show properties
codestringrequired
Allowed:conflictidempotency_conflict
messagestringrequired
request_idstring<uuid>required
413

payload_too_large

errorobjectrequired
Show properties
codestringrequired
Allowed:payload_too_large
messagestringrequired
request_idstring<uuid>required
415

unsupported_media_type

errorobjectrequired
Show properties
codestringrequired
Allowed:unsupported_media_type
messagestringrequired
request_idstring<uuid>required
429

rate_limited

errorobjectrequired
Show properties
codestringrequired
Allowed:rate_limited
messagestringrequired
request_idstring<uuid>required
500

internal_error

errorobjectrequired
Show properties
codestringrequired
Allowed:internal_error
messagestringrequired
request_idstring<uuid>required
Try it
Server
Authorization
Bodyapplication/json
Request
curl -X POST 'https://api.soljio.com/v0/queries/get_report' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "job_id": "string"
}'
Response
{
  "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"
}