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

# Rank the values one property of an event was sent with

`GET /v1/results/analytics/event-property-values`

Ranks one property's values, most sent first, with the number of times each
was sent. For

```js
silktide("open_accordion", { summary: accordion.querySelector("summary").textContent });
```

`event=open_accordion&property=summary` answers which accordions visitors
opened, and how often.

Name the event as `event` and the property as `property`, both exactly as your
site sends them. Take property names from
[Get event properties](https://developers.silktide.com/v1/analytics/engagement/get-event-properties.md). The
table is empty, not an error, when either is left out, when nothing sent the
event with that property in the period, and for a built-in event such as
`click`.

Every value is recorded as text, so `value` is a string even for a property
your site sent as a number. Only the times the event carried the property count, so an
event sent without it does not appear as an empty value.

To list the times the event was sent with one value, pass the same `property`
and the row's `value` to
[Get event occurrences](https://developers.silktide.com/v1/analytics/engagement/get-event-occurrences.md).

`search` matches the value. The table is sorted by `occurrences` 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

- `event` (string, required): The event, by the name your site sends, such as `newsletter_signup`. Only events your site sends have properties: left out, or a built-in event such as `click`, the table is empty.
- `property` (string, required): The property, exactly as your site sent it, such as `summary`; take names from Get event properties. Not trimmed: ` summary` is a different property. Left out, the table is empty.
- `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.
- `search` (string, optional): Only rows matching this text. What it searches depends on the table, most often the URL or title.
- `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.
    - `value` (string, required): One value the property was sent with, as text, such as `Delivery times`. Use it as `value` with Get event occurrences. Always returned, even when `columns` leaves it out.
    - `occurrences` (integer, required): How many times the event was sent with this value in the period.
    - `visitors` (integer, required): How many visitors sent the event with this value.
    - `previousOccurrences` (integer, optional): With `previousPeriod=1`, `occurrences` in the period before.
    - `previousVisitors` (integer, optional): With `previousPeriod=1`, `visitors` 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: Which accordions visitors opened

```bash
curl "https://api.eu.silktide.com/v1/results/analytics/event-property-values?event=open_accordion&property=summary&view=all&period=last-30-days&rowsPerPage=3" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"
```

Response:

```json
{
  "result": {
    "page": 1,
    "minPage": 1,
    "maxPage": 5,
    "numRows": 14,
    "rowsPerPage": 3,
    "rows": [
      {
        "value": "Delivery times",
        "occurrences": 412,
        "visitors": 355
      },
      {
        "value": "Return a bottle",
        "occurrences": 236,
        "visitors": 201
      },
      {
        "value": "Gift wrapping",
        "occurrences": 118,
        "visitors": 104
      }
    ]
  },
  "selector": "/v1/results/analytics/event-property-values",
  "duration": 0.027
}
```