Shared event timeseries

GET

/api/share/{token}/sites/{id}/events/timeseries

curl --request GET \
  --url 'https://hitkeep.com/api/share/example/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/events/timeseries?event_name=example&dimension_key=path'

Returns event timeseries through share token. Optional property filters and repeatable filter=type:value hit-dimension filters restrict the sessions counted.

Parameters

Path Parameters

token

required

string

id

required

string format: uuid

Query Parameters

from

string format: date-time

to

string format: date-time

event_name

required

string

property_key

string

property_value

string

filter

string

Filter in form type:value (repeatable). Supported types: path, hostname, referrer, referrer_host, device, country, browser, language, utm_campaign, utm_content, utm_medium, utm_source, utm_term.

dimension_key

deprecated

string

Allowed values: path hostname referrer referrer_host device country browser language utm_campaign utm_content utm_medium utm_source utm_term

Deprecated single event dimension filter. Prefer repeatable filter=type:value.

dimension_value

deprecated

string

Deprecated single event dimension value. Requires dimension_key.

Responses

200

Event timeseries

Media type application/json

Array<object>

object

count

integer

time

string format: date-time

Example ^generated

[
  {
    "count": 1,
    "time": "2026-04-15T12:00:00Z"
  }
]