Download Monthly Report ezeep Blue Quick Guide
This guide will lead you through the process of creating and downloading your monthly print reports.
Prerequisite
You will learn all the necessary steps once you created an Authorization Code using the Authorization Code Flow from authenticating a user with access and refresh tokens
Create Monthly Report
POST "https://api2.ezeep.com/reporting/reports"
| Attribute | Type | Data Type | Required | Description |
|---|---|---|---|---|
Authorization |
Header | string | yes | Bearer {{Access Token}} |
Content-Type |
Header | string | yes | application/json |
start |
body | string/timestamp | yes |
"2023-11-01" inclusive end of range |
end |
body | string/timestamp | yes |
"2023-12-01" exclusive end of range |
timestamp_offset |
body | integer32 | no |
0 - difference from UTC in hours |
csv_delimiter |
body | enum/string | no | [ ‘,’ , ‘;’ ] |
file_name_obfuscated |
body | boolean | no | true |
user_email_blank |
body | boolean | no | true |
user_name_blank |
body | boolean | no | true |
Example Request:
curl --location 'https://api2.ezeep.com/reporting/reports' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJK...' \
--data '{
"csv_delimiter": ",",
"end": "2023-12-01",
"file_name_obfuscated": true,
"start": "2023-11-01",
"timestamp_offset": 0,
"user_email_blank": true,
"user_name_blank": true
}'
The response code 202 - Accepted contains a JSON object of report details:
Example Response:
{
"report_id": "w4f213f3-ba3f-31d6-8g59-cfb342b27359",
"created": "2023-08-17T22:02:13.0616137Z",
"csv_delimiter": ",",
"end": "2023-12-01",
"file_name_obfuscated": true,
"format": "csv",
"start": "2023-11-01",
"status": "pending",
"timestamp_offset": 0,
"user_email_blank": true,
"user_id": "e69762f5-4156-41b3-cd62-f2394c7ac331",
"user_name_blank": true
}
The report shall state status: pending, when created. Please continue to poll until the status is succeeded
Timestamps
Timestamps written to the report will be UTC by default unless you explicitly pass timestamp_offset (-12 to 14, e.g., 2 for Berlin summer time).
timestamp_offset has no effect on which print jobs are included.
| Attribute | Type | Data Type | Required | Description |
|---|---|---|---|---|
start |
body | string/timestamp | yes | "2023-11-01T02:00:00Z" |
end |
body | string/timestamp | yes | "2023-12-01T02:00:00Z" |
Check Report Status
GET "https://api2.ezeep.com/reporting/<report_id>"
| Attribute | Type | Data Type | Required | Description |
|---|---|---|---|---|
Authorization |
Header | string | yes | Bearer {{Access Token}} |
Example Request:
curl --location 'https://api2.ezeep.com/reporting/reports/w4f213f3-ba3f-31d6-8g59-cfb342b27359' \
--header 'Authorization: Bearer eyJ0eXAiOiJK...'
Status Code: 200 OK
Example Response:
{
"report_id": "w4f213f3-ba3f-31d6-8g59-cfb342b27359",
"created": "2023-08-17T22:02:13.0616137Z",
"csv_delimiter": ",",
"end": "2023-09-01",
"file_name_obfuscated": true,
"format": "csv",
"start": "2023-08-01",
"status": "succeeded",
"timestamp_offset": 0,
"user_email_blank": true,
"user_id": "e69762f5-4156-41b3-cd62-f2394c7ac331",
"user_name_blank": true
}
The status: "succeeded" state that report is now complete and ready to download.
The status: "failed" states that Report could not be generated due to an unexpected error. May delete and retry, or contact support. API Contact Form
Download Report
GET "https://api2.ezeep.com/reporting/<report_id>/download"
| Attribute | Type | Data Type | Required | Description |
|---|---|---|---|---|
Authorization |
Header | string | yes | Bearer {{Access Token}} |
Example Request:
curl --location 'https://api2.ezeep.com/reporting/reports/w4f213f3-ba3f-31d6-8g59-cfb342b27359' \
--header 'Authorization: Bearer eyJ0eXAiOiJK...'
Status Code: 200 OK
Example Response:
A successful response with Content-Type: text/csv shall output Columns and Rows of the report.