Sign in
Reports

Queue an export of the course credit report

This endpoint queues an export of the course credit report.

get/shop/reports/course-credits/queue

Query parameters

site_idstring uuid required

Restrict the report to course credits belonging to the given site. Required, as the report resolves the site's course types to determine which credits to include.

course_type_idstring object-id

Filter credits by the course type they were purchased from.

'redeemable' | 'redeemed' | 'revoked' | 'expired'
OR
string[]

Filter credits by their computed status. Supports a single value or an array of values.

issued_at_fromstring date
Example:2026-01-01

Filter credits issued on or after this date. The date is interpreted in the site's local timezone.

issued_at_tostring date
Example:2026-03-31

Filter credits issued on or before this date. The date is interpreted in the site's local timezone.

Response

The job was successfully queued

Example response

{
  "data": {
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.