Pre-release — content may change.

Touchpoints

Touchpoint activity statistics

GET
/touchpoints_stats

A read-only, time-bucketed aggregate of touchpoint activity, grouped by service within each time bucket. The response is a JSON:API-shaped collection of per-bucket stat objects (type: touchpoints_stats) plus an aggregate meta block. This is an analytics endpoint, not a CRUD resource collection.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

filter?

Aggregation controls supplied as filter params:

  • filter[start_date] / filter[end_date] — ISO-8601 date bounds for the reporting window. Defaults to the trailing 12 months ending today.
  • filter[bucket_type] — one of auto, daily, weekly, monthly, quarterly, yearly (default monthly). auto selects a bucket size from the window length.

Additional filter predicates on Touchpoint attributes are also accepted to narrow the underlying touchpoints.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/touchpoints_stats"
{  "data": [    {      "type": "touchpoints_stats",      "id": "string",      "attributes": {        "bucket_type": "string",        "date": "2019-08-24",        "total_count": 0,        "top_service_count": 0,        "top_service_name": "string",        "service_counts": [          {            "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",            "service_name": "string",            "integration_type": "string",            "count": 0          }        ]      },      "relationships": {        "top_service": {          "data": {            "type": "services",            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"          }        }      }    }  ],  "meta": {    "total_in_period": 0,    "bucket_type": "string",    "start_date": "2019-08-24",    "end_date": "2019-08-24"  }}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}