Reports

Create report generation job

Changed on

Creates an asynchronous report job. Download the report once the job status is COMPLETED.

post/reports

Request

  • Base URL: https://api.session.services
  • URL: https://api.session.services/reports
  • Auth: API key in header x-tenant-id

Request body

OR
OR
OR
OR
OR

Response

OK

idstring required
type'PAYOUT_STATEMENT' | 'PAYOUT_ORDER_BREAKDOWN' | 'PAYOUT_BOOKING_FEE_BREAKDOWN' | 'PAYOUT_ADJUSTMENT_BREAKDOWN' | 'EVENT_ORDERS' | 'MEMBERSHIP_MEMBERS' required
status'QUEUED' | 'PROCESSING' | 'COMPLETED' | 'FAILED' required
createdAtstring required
updatedAtstring required
expiresAtstring
filenamestring
contentTypestring
sizeBytesnumber
errorstring
downloadUrlstring

Changes

  • 6369738f4d43Revision changes
    • warning

      added the new MEMBERSHIP_MEMBERS enum value to the response property for the response status

    • info

      added subschema #6 to the request body anyOf list

  • 84f157e4443aRevision changes
    • info

      added the non-success response with the status