Difference between revisions of "API: Reporting"

From Charitylog Manual
Jump to: navigation, search
Line 3: Line 3:
 
[[File:helpheader_small.png|right]]
 
[[File:helpheader_small.png|right]]
  
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:
+
Reporting is based on dimensions and metrics, conceptually similar to an X and Y axis, although metrics are optional.
 +
If you use a dimension, you will get a breakdown of the number of records by that dimension. For examplem, this will show you how many clients there are in each district:
  
 
  [GET] https<nowiki/>://api.dizions.co.uk/v2/clients/dimension/district
 
  [GET] https<nowiki/>://api.dizions.co.uk/v2/clients/dimension/district
  
If you want this further broken down by gender:
+
If you want this further, add a metric, for example, this breaks the client count down down by district and gender:
  
 
  [GET] https<nowiki/>://api.dizions.co.uk/v2/clients/dimension/district/metric/gender
 
  [GET] https<nowiki/>://api.dizions.co.uk/v2/clients/dimension/district/metric/gender

Revision as of 15:33, 26 August 2020

Go to API overview

Helpheader small.png

Reporting is based on dimensions and metrics, conceptually similar to an X and Y axis, although metrics are optional. If you use a dimension, you will get a breakdown of the number of records by that dimension. 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, add a metric, for example, this breaks the client count down down by district and 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*