API ReferenceOrders
Retrieve statistics from order ids
Retrieve statistics from order ids
Retrieve statistics from order ids
Authorization
ApiKey X-API-KEY<token>
In: header
Query Parameters
Id*string
Comma-separated list of campaign ids.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/order/analytics?Id=string"{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": { "orderId": 0, "status": "string", "orders": [ { "orderId": 0, "status": "string", "qrCode": { "totalScans": 0, "lastScan": "2019-08-24T14:15:22Z", "recipients": [ { "id": 0, "firstName": "string", "lastName": "string", "totalScans": "string", "lastScan": "2019-08-24T14:15:22Z" } ] }, "totalCards": 0, "mailed": 0, "inTransit": 0, "localFacility": 0, "delivered": 0, "undeliverable": 0, "waitingUSPS": 0, "paidDate": "string", "maxEstimatedDeliveredDate": "string", "minEstimatedDeliveredDate": "string", "postageType": "string", "orderStatus": "string", "campaignName": "string", "product": "string", "productionSpeed": "string" } ] }, "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "metadata": { "property1": null, "property2": null }}{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": { "orderId": 0, "status": "string", "orders": [ { "orderId": 0, "status": "string", "qrCode": { "totalScans": 0, "lastScan": "2019-08-24T14:15:22Z", "recipients": [ { "id": 0, "firstName": "string", "lastName": "string", "totalScans": "string", "lastScan": "2019-08-24T14:15:22Z" } ] }, "totalCards": 0, "mailed": 0, "inTransit": 0, "localFacility": 0, "delivered": 0, "undeliverable": 0, "waitingUSPS": 0, "paidDate": "string", "maxEstimatedDeliveredDate": "string", "minEstimatedDeliveredDate": "string", "postageType": "string", "orderStatus": "string", "campaignName": "string", "product": "string", "productionSpeed": "string" } ] }, "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "metadata": { "property1": null, "property2": null }}{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": { "orderId": 0, "status": "string", "orders": [ { "orderId": 0, "status": "string", "qrCode": { "totalScans": 0, "lastScan": "2019-08-24T14:15:22Z", "recipients": [ { "id": 0, "firstName": "string", "lastName": "string", "totalScans": "string", "lastScan": "2019-08-24T14:15:22Z" } ] }, "totalCards": 0, "mailed": 0, "inTransit": 0, "localFacility": 0, "delivered": 0, "undeliverable": 0, "waitingUSPS": 0, "paidDate": "string", "maxEstimatedDeliveredDate": "string", "minEstimatedDeliveredDate": "string", "postageType": "string", "orderStatus": "string", "campaignName": "string", "product": "string", "productionSpeed": "string" } ] }, "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "metadata": { "property1": null, "property2": null }}{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": { "orderId": 0, "status": "string", "orders": [ { "orderId": 0, "status": "string", "qrCode": { "totalScans": 0, "lastScan": "2019-08-24T14:15:22Z", "recipients": [ { "id": 0, "firstName": "string", "lastName": "string", "totalScans": "string", "lastScan": "2019-08-24T14:15:22Z" } ] }, "totalCards": 0, "mailed": 0, "inTransit": 0, "localFacility": 0, "delivered": 0, "undeliverable": 0, "waitingUSPS": 0, "paidDate": "string", "maxEstimatedDeliveredDate": "string", "minEstimatedDeliveredDate": "string", "postageType": "string", "orderStatus": "string", "campaignName": "string", "product": "string", "productionSpeed": "string" } ] }, "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "metadata": { "property1": null, "property2": null }}