Analytics
Analytics Documentation
Analytic [GET]
Analytic [GET]
Request
Endpoint
GET /api/v2/tools/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": "tools::analytics",
"type": "tools_analytics",
"attributes": {
"counts_by_type": [
{
"id": "2e3a286b-cda3-48e0-a6ee-cadf874bfd03",
"counts": [
{
"type": "fix-commitment-info",
"count": 0
},
{
"type": "fix-phone-numbers",
"count": 0
},
{
"type": "fix-email-addresses",
"count": 0
},
{
"type": "fix-addresses",
"count": 0
},
{
"type": "fix-send-newsletter",
"count": 0
},
{
"type": "duplicate-contacts",
"count": 0
},
{
"type": "duplicate-people",
"count": 0
}
]
}
],
"created_at": "2021-11-23T14:37:42Z",
"updated_at": null,
"updated_in_db_at": null
}
}
}
Fields
Attributes
counts_by_type
Type
object
Description Gives the number of contacts, addresses, phone numbers and email addresses that need to be fixed by the user. It also gives a count of the number of duplicated contacts and people associated to them.
created_at
Type
date
Description The timestamp of when this resource was created
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.
Last updated