Difference between revisions of "API: Reporting"
m (Msim moved page Reporting Via The API to API: Reporting) |
|
(No difference)
| |
Revision as of 15:29, 26 August 2020
Reporting is based on dimensions and metrics, conceptually similar to an X and Y axis, although metrics are optional. If you pass in a dimension against a group, you will get a breakdown of the number of records in that group. For examplem, this will show you how many clients there are in each district:
[GET] https://api.dizions.co.uk/v2/clients/dimension/district
If you want this further broken down by gender:
[GET] https://api.dizions.co.uk/v2/clients/dimension/district/metric/gender
You can also filter the results in the same way as other [GET] requests:
[GET] https://api.dizions.co.uk/v2/clients/dimension/district/metric/gender/main_disability/7;9/blue_badge_holder/Y
To view a user's completed contacts by day for a range of time, you can do this:
[GET] https://api.dizions.co.uk/v2/done_contacts/dimension/day/date_active/2018-10-01,2018-10-31/user/*USER_ID*
