Table 6. API Resources for Batch Analytics
|
|
|
|
GET |
/batchrpts |
status:{completed, pending, failed}; hierarchyType: {"BILLING", "BUSINESS", or custom} If hierarchyType is null, it returns batchRpt for both types. The hierarchyType parameter applies only to B2B users; it is ignored for B2C users. |
Returns a list of batch reports that the user can access. |
GET |
/batchrpts/scheduled |
None |
Returns a list of scheduled batch reports that the user can access. |
GET |
/batchrpts/scheduled/{batrptId} |
None |
Returns a recurring batch report request that is scheduled. |
DELETE |
/batchrpts/scheduled/{batrptId} |
None |
Deletes a recurring batch report request that is scheduled. |
GET |
/batchrpts/{batrptId} |
None |
Returns a batch report request. |
DELETE |
/batchrpts/{batrptId} |
None |
Deletes a batch report. |
GET |
/batchrpts/{batchrptId}/content |
None |
Returns batch report result content with pagination on. |
GET |
/batchrpts/{batchrptId}/download |
downloadFormat: {xml, csv, pdf} |
Downloads a batch report in the specified format. |