Documentation · API reference
GET
/api/v1/sites/{site}/goalsA site's goals
This page as Markdown, or in an AI chatMore ways to read this page
A site's goals, with their definitions.
# A site's goals
> tidekeeper's API reference: https://tidekeeper.eu/docs/api/get-sites-site-goals
`GET /api/v1/sites/{site}/goals`
A site's goals, with their definitions.
## Parameters
- `site` (in path, needed): A site's id or name
## The answer
200, `A list of GoalView`
- `created_at` (string, needed)
- `id` (string, needed)
- `name` (string, needed)
- `paused` (boolean, needed)
- `site_id` (string, needed)
- `spec` (object, needed)
- `summary` (string, needed): `event install-copy`, `page /thanks*`.
- `version` (integer, needed): The version in force. Each conversion records the one it was counted under (EV-06).
## Asking
```sh
curl https://tidekeeper.eu/api/v1/sites/example.org/goals \
-H "Authorization: Bearer $TIDEKEEPER_TOKEN"
```
Parameters
- sitein the address
- neededA site's id or name
The answer
Status 200
A list of GoalView
- created_at
- stringneeded
- id
- stringneeded
- name
- stringneeded
- paused
- booleanneeded
- site_id
- stringneeded
- spec
- objectneeded
- summary
- stringneeded`event install-copy`, `page /thanks*`.
- version
- integerneededThe version in force. Each conversion records the one it was counted under (EV-06).
Asking
curl https://tidekeeper.eu/api/v1/sites/example.org/goals \ -H "Authorization: Bearer $TIDEKEEPER_TOKEN"
const answer = await fetch("https://tidekeeper.eu/api/v1/sites/example.org/goals", { headers: { Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`, }, }).then((r) => r.json());