How to Create a Report
Important: RDE reports contain sensitive information. Grant RDE privileges {Application Reporting and Data Export: RDE Global, Application Reporting and Data Export: RDE Access} to users who have access to sensitive information in UX1.
Creating a report through the UI
To create a report, perform the following steps:
-
Log in to UX1.
-
Go to Analytics > Reporting and Data Export and click Create Report.
-
(Optional) If an additional data set is enabled, the report generation screen includes the step Select Data Set. Select the required data set type and click Next.
-
(Optional) If a simplified report view is configured, you can select it. Otherwise, a full report view will be created.
-
Provide the report title, select a period and file format, then click Create.
Creating a report through the Platform API
To create reports using the platform API, follow these instructions:
-
Get a list of data sets with the following command:
curl -E /usr/local/pem/APS/certificates/poa.pem -X GET "https://localhost:6308/aps/2/resources?implementing(http://www.odin.com/rde/global-data-set/1.)" -k | python -m json.tool
For example, you receive the following output:{ "aps": { "id": "1bf83517-032f-4de4-a63a-d8e8e2614987", "modified": "2022-04-07T11:27:08Z", "revision": 3, "status": "aps:ready", "type": "http://www.odin.com/rde/global-data-set/1.0" }, "dataSetType": "payment", "description": { "de_DE": "Alle Zahlungs- und R\u00fcckerstattungstransaktionen mit den dazugeh\u00f6rigen Informationen eines Kundenkontos, Zahlungsmethoden und E-Transaktionen.", "en_US": "All payment and refund transactions with the associated information of a customers accounts, payment methods and e-transactions." }, "title": { "de_DE": "Zahlungen", "en_US": "Payments" } }
-
Generate a report with the required custom data set. (See the request example below.)
Note: Refer to this documentation for standard call examples.
Example:POST /aps/2/resources { "aps":{ "type":"http://www.odin.com/rde/report-template/1.4" }, "commonName":"PAYMENT via API 3", "parameters":{ "startDate":"2021-09-09T00:00:00Z", "endDate":"2021-10-05T23:59:59Z" }, "format":"XLSX", "notifyByEmail":false, "eventType":"ONETIME", "dataSet": { "aps": { "id": "1bf83517-032f-4de4-a63a-d8e8e2614987", "modified": "2022-04-07T11:27:08Z", "revision": 3, "status": "aps:ready", "type": "http://www.odin.com/rde/global-data-set/1.0" } } }
cURL example:curl -X POST "https://localhost:6308/aps/2/resources" -k -H "Accept: application/json" -H "Content-Type: application/json" -H "APS-Token: JEFFUy0xMjgtR0NNJDN6YU4wWDdBZmpvaFMyY3kkZ3JOQnk2N1BYZ3poSFB2VGpmaVIvYWxxZ0M5ZUJaZGNhV2dzdVZObjFDMWFyeE9BM1Bsa0orSFU5cUw5UGVBdnRxdWpMaUxQODNpQUliaVZVc0VkNXdlblBvTU9KczFtWDRtQjJVQTllM2ZSVUZPMngwaFE5WTBZSk5JeFNBMWZScXJram5BZ0cwdmZNTStUQmV3N3JVOVhaQXZGYVdwcXlCNnI3TlYrTjFuSHpvWkRvdVdVQ0FmdTVuUlNJNThsRGhEWGNUdytlL0NscUI1TjN4OElJdGs5bDI0d1RSK29mYlJsb0l1S2hiRWd3Sy9qYW53RGNLcGc3aHUvNDUwQlduWXVxVFhReWNXWnlsTndleVl1SXFrTFNaVkxaYnZsU2NpeGpyRDRmY1NyNlZuSUp4ODNKQ3V4WVRWbEk5QlRyTjU3UWRpUjE4c1pHZGV1SzRCNkV6dEdQYnJQc2hBNXlhM1h4d1B1YkZJb3BZMHlwYWVGa0tCUVpYeitvR0lCeXM4NGg5Rm5GbUFzbXAwVWQyTkZXdWtJVEZNYUtBNER4VW5TY3V6N2ZUSkQyeFE9" -d'{"aps":{"type":"http://www.odin.com/rde/report-template/1.4"},"commonName":"PAYMENT via API 3","parameters":{"startDate":"2018-09-09T00:00:00Z","endDate":"2018-10-05T23:59:59Z"},"format":"XLSX","notifyByEmail":false,"eventType":"ONETIME", "dataSet": {"aps": {"id": "1bf83517-032f-4de4-a63a-d8e8e2614987","modified": "2022-04-07T11:27:08Z","revision": 3,"status": "aps:ready","type": "http://www.odin.com/rde/global-data-set/1.0"}}}' | python -m json.tool