Sign in

v1

latestOpenAPI 3.0.02026-07-14205154.3 KB
Reports

Generate report

This endpoint creates a new report in the format of a CSV file and sends it via email. You can generate one of the following reports:

  • subscriptionsWithStatus

  • subscriptionsScheduledBetweenDate

  • subscriptionsUpdatedBetweenDate

  • subscriptionsCreatedBetweenDate

  • executionsBetweenDate

post/api/rns/pvt/reports/{reportName}/documents

Path parameters

reportNamestring nullable required

Name of the type of report in wish to generate. The following values are accepted:

  • subscriptionsWithStatus

  • subscriptionsScheduledBetweenDate

  • subscriptionsUpdatedBetweenDate

  • subscriptionsCreatedBetweenDate

  • executionsBetweenDate

Query parameters

emailstring

The report is sent to the email in this field.

beginDatestring

Start date of the report with the format yyyy-mm-dd. This field is required for any type of report.

endDatestring

End date of the report with the format yyyy-mm-dd. This field is required for any type of report.

Headers

Content-Typestring required
Example:application/json

Type of the content being sent.

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

Requested report

canceledboolean
completedDatestring date-time nullable
emailstring nullable
enqueueDatestring date-time nullable
errorCountinteger nullable
finishedboolean
idstring nullable
lastErrorMessagestring nullable
lastUpdateTimestring date-time nullable
linkToDownloadstring nullable
outputTypestring nullable
percentageProcessedinteger
recordsProcessedinteger
recordsSuminteger nullable
startDatestring date-time nullable
statusMessagestring nullable
zippedboolean