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-12-19..2021-12-25",
      "type": "reports_tag_histories_periods",
      "attributes": {
        "created_at": "2022-01-12T17:18:06Z",
        "end_date": "2021-12-25",
        "start_date": "2021-12-19",
        "tags": [

        ],
        "updated_at": null,
        "updated_in_db_at": null
      }
    },
    {
      "id": "2021-12-26..2022-01-01",
      "type": "reports_tag_histories_periods",
      "attributes": {
        "created_at": "2022-01-12T17:18:06Z",
        "end_date": "2022-01-01",
        "start_date": "2021-12-26",
        "tags": [

        ],
        "updated_at": null,
        "updated_in_db_at": null
      }
    },
    {
      "id": "2022-01-02..2022-01-08",
      "type": "reports_tag_histories_periods",
      "attributes": {
        "created_at": "2022-01-12T17:18:06Z",
        "end_date": "2022-01-08",
        "start_date": "2022-01-02",
        "tags": [

        ],
        "updated_at": null,
        "updated_in_db_at": null
      }
    },
    {
      "id": "2022-01-09..2022-01-15",
      "type": "reports_tag_histories_periods",
      "attributes": {
        "created_at": "2022-01-12T17:18:06Z",
        "end_date": "2022-01-15",
        "start_date": "2022-01-09",
        "tags": [

        ],
        "updated_at": null,
        "updated_in_db_at": null
      }
    },
    {
      "id": "2021-12-19..2022-01-15",
      "type": "reports_tag_histories_periods",
      "attributes": {
        "created_at": "2022-01-12T17:18:06Z",
        "end_date": "2022-01-15",
        "start_date": "2021-12-19",
        "tags": [

        ],
        "updated_at": null,
        "updated_in_db_at": null
      }
    }
  ],
  "meta": {
    "filter": {
    }
  }
}

Fields

data

Type [Tag Histories Period]

Description An array of Tag Histories Periods