Event properties

This page as Markdown, or in an AI chatMore ways to read this page

An event's properties, or how often each value of one of them was sent.

# Event properties

> tidekeeper's API reference: https://tidekeeper.eu/docs/api/get-sites-site-props

`GET /api/v1/sites/{site}/props`

An event's properties, or how often each value of one of them was sent.

## Parameters

- `site` (in path, needed): A site's id or name
- `event` (in query): The event. Left out, views
- `key` (in query): One property, to list its values

## The answer

200, `A list of Counted`

- `count` (integer, needed)
- `key` (string, needed)

## Asking

```sh
curl -G https://tidekeeper.eu/api/v1/sites/example.org/props \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
    -d event=Order -d period=30d
```

Parameters

sitein the address: neededA site's id or name
eventin the query: The event. Left out, views
keyin the query: One property, to list its values

The answer

Status 200

A list of Counted

count: integerneeded
key: stringneeded

Asking

curlJavaScript

With your token from Settings

curl -G https://tidekeeper.eu/api/v1/sites/example.org/props \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
    -d event=Order -d period=30d

With your token from Settings

const answer = await fetch("https://tidekeeper.eu/api/v1/sites/example.org/props?event=Order&period=30d", {
  headers: {
    Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`,
  },
}).then((r) => r.json());