Difference between revisions of "API: Reporting"

From Charitylog Manual
Jump to: navigation, search
(Created page with "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 dim...")
 
 
(9 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
[[API Details| Go to API overview]]
 +
 
[[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.
−
 
+
If you use a dimension, you will get a breakdown of the number of records by that dimension. For example, 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
+
[GET] https<nowiki/>://api.dizions.co.uk/v2/clients/dimension/district
  
−
You can also filter the results in the same way as other [GET] requests:
+
If you want this further, add a metric, for example, this breaks the client count down by district and gender:
  
−
[GET] https://api.dizions.co.uk/v2/clients/dimension/district/metric/gender/main_disability/7;9/blue_badge_holder/Y
+
[GET] https<nowiki/>://api.dizions.co.uk/v2/clients/dimension/district/metric/gender
  
−
To view a user's completed contacts by day for a range of time, you can do this:
+
You can also filter the results in the same way as other [GET] requests, for example, this shows the same report, but only for clients with disability 7 or 9 who have a blue badge:
  
−
[GET] https://api.dizions.co.uk/v2/done_contacts/dimension/day/date_active/2018-10-01,2018-10-31/user/*USER_ID*
+
[GET] https<nowiki/>://api.dizions.co.uk/v2/clients/dimension/district/metric/gender/main_disability/7;9/blue_badge_holder/Y
  
−
----
+
The format is the same for most endpoints, for example, this shows a user's completed contacts by day during October:
 +
[GET] https<nowiki/>://api.dizions.co.uk/v2/done_contacts/dimension/day/date_active/2018-10-01,2018-10-31/user/SPECIFY_A_USER_ID

Latest revision as of 11:42, 2 August 2024

Go to API overview

Helpheader small.png

Reporting is based on dimensions and metrics, conceptually similar to an X and Y axis. If you use a dimension, you will get a breakdown of the number of records by that dimension. For example, 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 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, for example, this shows the same report, but only for clients with disability 7 or 9 who have a blue badge: 

[GET] https://api.dizions.co.uk/v2/clients/dimension/district/metric/gender/main_disability/7;9/blue_badge_holder/Y

The format is the same for most endpoints, for example, this shows a user's completed contacts by day during October: 

[GET] https://api.dizions.co.uk/v2/done_contacts/dimension/day/date_active/2018-10-01,2018-10-31/user/SPECIFY_A_USER_ID
Retrieved from ‘https://wiki.dizions.co.uk/index.php?title=API:_Reporting&oldid=18345’