Analytics
Analytics Documentation
Analytic [GET]
Analytic [GET]
Request
Endpoint
GET /api/v2/contacts/analytics
Content-Type: application/vnd.api+json
Body
Parameters
Filters
account_list_id
Type string
Description The account list to run the analytics report on
Required No
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
Body
{
"data": {
"id": "contact::analytics",
"type": "contact_analytics",
"attributes": {
"created_at": "2021-11-23T14:38:30Z",
"first_gift_not_received_count": 3,
"partners_30_days_late_count": 0,
"partners_60_days_late_count": 0,
"partners_90_days_late_count": 0,
"updated_at": null,
"updated_in_db_at": null
},
"relationships": {
"birthdays_this_week": {
"data": [
{
"id": "6fb7815a-2840-4db5-a298-dd4e20210ef4",
"type": "people"
},
{
"id": "50555f00-0b3d-44df-b561-1fed315edd06",
"type": "people"
}
]
},
"anniversaries_this_week": {
"data": [
{
"id": "e00ba8d7-0371-46cf-bf37-56615b0bd143",
"type": "contacts"
}
]
},
"first_gift_not_received_contacts": {
"data": [
{
"id": "e00ba8d7-0371-46cf-bf37-56615b0bd143",
"type": "contacts"
},
{
"id": "6a7ee240-e171-4501-a668-e2093c2fb191",
"type": "contacts"
},
{
"id": "5c6108cb-3bb2-4b00-b802-a58ba1ce32a0",
"type": "contacts"
}
]
},
"partners_30_days_late_contacts": {
"data": [
]
},
"partners_60_days_late_contacts": {
"data": [
]
},
"partners_90_days_late_contacts": {
"data": [
]
}
}
}
}
Fields
Attributes
created_at
Type
date
Description The timestamp of when this resource was created
first_gift_not_received_count
Type
number
Description First gift not received count
partners_30_days_late_count
Type
number
Description Partners 31 to 60 Days Late Count
partners_60_days_late_count
Type
number
Description Partners 61 to 90 Days Late Count
partners_90_days_late_count
Type
number
Description Partners 91 Days Late Count
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Relationships
anniversaries_this_week.data
Type
Contact
Description Contacts with people who have anniversaries this week
birthdays_this_week.data
Type
Person
Description People with birthdays this week
first_gift_not_received_contacts.data
Type
Contact
Description Contacts where the first gift has not been received
partners_30_days_late_contacts.data
Type
Contact
Description Contacts 31 to 60 Days Late
partners_60_days_late_contacts.data
Type
Contact
Description Contacts 61 to 90 Days Late
partners_90_days_late_contacts.data
Type
Contact
Description Contacts 90 Days Late
Last updated