Contribution Events Analytics API
The Contribution Events analytics API endpoint gives you data that you would find in the Site Contributions report, Group Comparison report, and User Comparison report. Each row in the report represents an event. This data can be requested by month, week or day. A 48 hour data settling period is required in order to ensure the API call captures all data for the requested time frame. For example, data for 4/22 should be requested on 4/24. If called sooner, data will be retrieved but it may not include all events.
API endpoints:
- Month:
/@api/deki/site/analytics/contributionevents?month=YYYY-MM - Week:
/@api/deki/site/analytics/contributionevents?YYYY-MM-W (W= week of month. For example, first week of month W = 1) - Day:
/@api/deki/site/analytics/contributionevents?day=YYYY-MM-DD
This will give you a result with the following data:
| Name | Description | Type | Example |
|---|---|---|---|
| EVENT_DATE |
The date the event occurred Data is stored in UTC |
DATE (M/D/YYYY) | 6/1/2023
12/22/2023 |
| EVENT_ID | The unique identifier for the event | STRING | 03472928-00d8-11ee-a869-719f334a7d1d |
| EVENT_TYPE | The kind of event that occurred | STRING |
Create Copy Delete Move Edit |
| PAGE_PATH | The page where the event occurred | STRING | Admin/Branding/Branding_Guidelines/Logos_and_icons |
| SESSION_ID | Indicates which events belong to which sessions | STRING | site_11706:efac2fe8-c43f-4e17-b5d7-081908ce7a77:1 |
| SITE_ID | The site where the event occurred | STRING | site_11706 |
| USER_ID | The user who performed the event | NUMBER | 756 |