Get connect-rate heatmap

Connect rate and call count by weekday and hour. Pass tz (time zone name, default UTC) to bucket hours in your local time.

GET /analytics/heatmap

Get connect-rate heatmap

cURL

curl --request GET \
  --url https://api.pineyard.ai/analytics/heatmap \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "day": 3,
    "hourBucket": 3,
    "connectRate": 50,
    "totalCalls": 1
  }
]

Required scope: analytics.view

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Query Parameters

days · integer

Required range: 1 <= x <= 365

tz · string

campaignTypeId · string

campaignId · string

Response

200

application/json

OK

day · integer · required

Required range: 0 <= x <= 6

hourBucket · integer · required

Required range: 0 <= x <= 6

connectRate · number · required

Required range: 0 <= x <= 100

totalCalls · integer · required

Required range: x >= 0