Tag Histories
Tag Histories Documentation
Tag History [LIST]
Tag History [LIST]
Request
Endpoint
GET /api/v2/reports/tag_histories
Content-Type: application/vnd.api+json
Body
Parameters
Filters
account_list_id
Type string
Description The account list to run the report on.
Required No
association
Type string
Description Tags counts for either 'contacts' or 'tasks' Default: contacts
Required No
end_date
Type string
Description The date in which you would like the report to end on. This will be shifted to the end of the final period. Default: today
Required No
range
Type string
Description A string defining the number of periods and how long they should be with an indictor: (d)ay, (w)eek, (m)onth, (y)ear. Examples: 30d, 2w, 12m, 1y. Default: 13m
Required No
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
Body
{
"data": [
{
"id": "2021-10-31..2021-11-06",
"type": "reports_tag_histories_periods",
"attributes": {
"created_at": "2021-11-23T14:38:15Z",
"end_date": "2021-11-06",
"start_date": "2021-10-31",
"tags": [
],
"updated_at": null,
"updated_in_db_at": null
}
},
{
"id": "2021-11-07..2021-11-13",
"type": "reports_tag_histories_periods",
"attributes": {
"created_at": "2021-11-23T14:38:15Z",
"end_date": "2021-11-13",
"start_date": "2021-11-07",
"tags": [
],
"updated_at": null,
"updated_in_db_at": null
}
},
{
"id": "2021-11-14..2021-11-20",
"type": "reports_tag_histories_periods",
"attributes": {
"created_at": "2021-11-23T14:38:15Z",
"end_date": "2021-11-20",
"start_date": "2021-11-14",
"tags": [
],
"updated_at": null,
"updated_in_db_at": null
}
},
{
"id": "2021-11-21..2021-11-27",
"type": "reports_tag_histories_periods",
"attributes": {
"created_at": "2021-11-23T14:38:15Z",
"end_date": "2021-11-27",
"start_date": "2021-11-21",
"tags": [
],
"updated_at": null,
"updated_in_db_at": null
}
},
{
"id": "2021-10-31..2021-11-27",
"type": "reports_tag_histories_periods",
"attributes": {
"created_at": "2021-11-23T14:38:15Z",
"end_date": "2021-11-27",
"start_date": "2021-10-31",
"tags": [
],
"updated_at": null,
"updated_in_db_at": null
}
}
],
"meta": {
"filter": {
}
}
}
Fields
data
Type
[Tag Histories Period]
Description An array of Tag Histories Periods
Last updated