<!-- https://developers.silktide.com/v1/analytics/engagement/get-goals | Analytics / Engagement -->

# List goals and how often each was completed

`GET /v1/results/analytics/goals`

Lists every goal of the view, or of the website, with how many times each was
completed in the period and the share of visitors who completed it, most
completed first. A view lists its own goals and the goals of every view inside
it, so `view=all` lists every goal in the account.

Every goal is listed, including one nobody completed in the period, which
shows `0` for both. Goals are created and changed in Silktide; the API reads
them.

The rows say what a goal matches in `goal`, but not whether it is a page or an
event goal, nor whether a page goal needs the exact address or any address
containing it. Two goals that match the same thing show the same figures.

This table has no `search`. It is sorted by `totalConversions` unless you send
`sort`. See [Tables](https://developers.silktide.com/v1/concepts/tables.md) and, for `view`, `period` and
`filters`, [Analytics](https://developers.silktide.com/v1/analytics.md).

## Request

### Query parameters

- `view` (string, optional, matches `^(all|[1-9]\d*)$`): The analytics view to read: its id, the number after `/analytics/` in its address in Silktide, or `all` for all of the account's analytics. Send this or `websiteId`.
- `websiteId` (integer, optional, at least 1): Instead of `view`, a website whose analytics to read. The website must have Analytics set up.
- `sectionId` (integer, optional): With `websiteId`, a section of the website. Defaults to `0`, the whole website.
- `period` (string, optional): The date range. Defaults to `all`. The spaced forms (`-7 days`, `month to date`) are older names that keep working. `custom` needs `from` and `to`. One of: `all`, `today`, `last-7-days`, `last-30-days`, `last-90-days`, `month-to-date`, `last-month`, `year-to-date`, `last-12-months`, `custom`, `-7 days`, `-30 days`, `-90 days`, `-1 month`, `month to date`, `year to date`, `-12 months`.
- `from` (string, optional): With `period=custom`, the first day, such as `2026-10-01`.
- `to` (string, optional): With `period=custom`, the last day.
- `timezone` (string, optional): The IANA time zone days are read in, such as `America/New_York`. Defaults to `UTC`.
- `filters` (map of strings, optional): Only visits matching every filter, keyed by what is filtered: `filters[url]=contains:/blog`. Each value is `{operator}:{value}`, with operator `is`, `not`, `contains`, `starts`, `gt` or `lt`. Keys include `url`, `hostName`, `entryUrl`, `exitUrl`, `event`, `outgoingUrl`, `referrer`, `source`, `medium`, `campaign`, `content`, `term`, `countryCode`, `regionCode`, `language`, `deviceType` (`desktop`, `tablet` or `mobile`), `operatingSystem` and `browser`.
- `columns` (string, optional): The columns to return, comma-separated, such as `url,pageViews`. Left out, the table's default columns. Send a string even in a JSON body: an array is ignored.
- `sort` (string, optional): The column to sort by, then `:a` for ascending or `:d` for descending, such as `pageViews:d`. Left out, the table's own order.
- `page` (integer, optional, at least 1): The page of rows to return, from `1`. Defaults to `1`.
- `rowsPerPage` (integer, optional, at least 1): How many rows a page holds. Defaults to `100`.
- `previousPeriod` (string, optional): `1` to add the figures of the period before, the same length and ending where this one starts, as `previous…` fields. Left out or `0`, none. Needs a `period` with a start: with `all`, nothing is added. One of: `0`, `1`.

## Response

Status `200`.

- `result` (object, required): The answer.
  - `page` (integer, required, at least 1): The page returned. Not always the page asked for, when that was out of range.
  - `minPage` (integer, required, at least 1): The first page. Always `1`.
  - `maxPage` (integer, required): The last page at this `rowsPerPage`. With no rows, `0` or `1` depending on the table.
  - `numRows` (integer, required): How many rows there are across every page.
  - `rowsPerPage` (integer, required, at least 1): How many rows a page holds.
  - `rows` (list of objects, required): The rows on this page.
    - `goalId` (integer, required, at least 1): The goal's id. Always returned, even when `columns` leaves it out.
    - `name` (string, required): The goal's name, as it was given in Silktide, such as `Signed up`.
    - `goal` (string, required): What the goal matches: a page's address, or part of one, for a page goal, and the event's name for an event goal.
    - `totalConversions` (integer, required): How many times the goal was completed in the period.
    - `conversionRate` (number, required): The percentage of the period's visitors who completed it, from `0` to `100`.
    - `previousTotalConversions` (integer, optional): With `previousPeriod=1`, `totalConversions` in the period before.
    - `previousConversionRate` (number, optional): With `previousPeriod=1`, `conversionRate` in the period before.
- `selector` (string, required): The query that answered, as its path: `/v1/results/scores`.
- `duration` (number, required): Seconds Silktide took to answer.

## Errors

| Status | Type | When |
| --- | --- | --- |
| 404 | `ModelNotFound` | No view or website with that id exists in the account, or the API key's user cannot see it. |
| 403 | `AccessDenied` | The API key's user cannot read that analytics view. |
| 200 | `ModelNotFound` | The website has no Analytics set up. The body is an error despite the status. |
| 200 | `InvalidRequest` | Neither `view` nor `websiteId` was sent. The error's own `status` is `400` and `properties.field` is `view`. The body is an error despite the status. |
| 200 | `InvalidArgument` | A filter names a key or operator Analytics does not know. The body is an error despite the status. |
| 401 | `NotLoggedIn` | No API key was sent, or it is not a key for this region. |
| 429 | `TooManyRequests` | Too many requests to this path in five seconds. Retry after the number of seconds in the `Retry-After` header, which `properties.retryAfter` repeats. |
| 503 | - | Silktide is busy. Retry after the number of seconds in the `Retry-After` header. |

## Access

- Permission: View analytics view (View all analytics for `view=all`)
- Plan feature: none
- Edition: Silktide 4 and Silktide 5
- Cost: free
- Stability: stable, since 1.0.0

## Example: A view's goals over the last 30 days

```bash
curl "https://api.eu.silktide.com/v1/results/analytics/goals?view=12&period=last-30-days" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"
```

Response:

```json
{
  "result": {
    "page": 1,
    "minPage": 1,
    "maxPage": 1,
    "numRows": 2,
    "rowsPerPage": 100,
    "rows": [
      {
        "goalId": 4,
        "name": "Contacted us",
        "goal": "https://fakewinebarrel.com/contact-us/thank-you",
        "totalConversions": 312,
        "conversionRate": 3.84
      },
      {
        "goalId": 7,
        "name": "Signed up",
        "goal": "newsletter_signup",
        "totalConversions": 198,
        "conversionRate": 2.43
      }
    ]
  },
  "selector": "/v1/results/analytics/goals",
  "duration": 0.032
}
```