List event properties

Returns the property names of one or more custom events, e.g. to group or filter by them with the `event:prop:<name>` token.

This endpoint lists the property names of one or more custom events, for example the plan property of a signup event, together with how many events and unique users have each property in the given date range. You can pass up to 25 event names at once, and get back one property list per event, sorted by the number of events that have each property. Events without properties in the period come back with an empty list.

Use the returned names to group by an event property with "groupBy": ["event:prop:<name>"] in the query endpoint, or to filter by it with an event filter. Grouping by a property together with an event filter for the event gives you the users and events per property value (see the “Breakdown of an event property” example there). To find the names of your custom events, use the filter values endpoint with the event:name field.

Examples

Below you can see several examples of how to use this endpoint. Further down this page, you can find a detailed reference of all the available options you can pass.

Copy the JSON body of any of these examples, and use it in a POST request to https://api.vemetric.com/v1/events/properties with your API key.

{
  "eventNames": ["signup"],
  "dateRange": "30days"
}

{
  "eventNames": ["signup", "purchase", "invite_sent"],
  "dateRange": "30days"
}

{
  "eventNames": ["signup"],
  "dateRange": "7days",
  "filters": [
    {
      "type": "location",
      "country": {
        "operator": "oneOf",
        "value": ["DE"]
      }
    }
  ]
}

{
  "eventNames": ["purchase"],
  "dateRange": ["2026-01-01", "2026-01-31"],
  "limit": 50,
  "offset": 50
}

Headers

Request Body (required)

Responses