Data Lookups

The Lookup APIs allow you to retrieve metadata about various entities in your Userpilot account, such as user properties, company properties, features, events, and more.

User & Company

Endpoints for retrieving user and company metadata, as well as segments.

Endpoint	Description
`/api/v1/analytics/exports/lookups/user_properties`	Get user properties
`/api/v1/analytics/exports/lookups/company_properties`	Get company properties
`/api/v1/analytics/exports/lookups/segments`	Get segments (paginated)

Features & Events

Endpoints for retrieving features, events, and event property metadata.

Endpoint	Description
`/api/v1/analytics/exports/lookups/features_events`	Get features & events
`/api/v1/analytics/exports/lookups/events_properties`	Get trackable events’ properties/attributes (paginated)

Experiences & UI

Endpoints for retrieving experiences, UI elements, surveys, resource center modules, and checklists.

Endpoint	Description
`/api/v1/analytics/exports/lookups/flows`	Get flows (experiences)
`/api/v1/analytics/exports/lookups/banners`	Get banners
`/api/v1/analytics/exports/lookups/embeds`	Get embeds (banners and cards)
`/api/v1/analytics/exports/lookups/spotlights`	Get spotlights
`/api/v1/analytics/exports/lookups/surveys`	Get surveys (with modules)
`/api/v1/analytics/exports/lookups/resource_center_modules`	Get resource center modules
`/api/v1/analytics/exports/lookups/checklists`	Get checklists (with tasks)

How to Use

All endpoints require authentication via your API key:

curl --location 'https://appex.userpilot.io/api/v1/analytics/exports/lookups/user_properties' \
--header 'Authorization: Token {{API_KEY}}'

Example Response

[
  {
    "display_name": "URL",
    "key": "url",
    "data_type": "string",
    ...
  }
]

Pagination

Some endpoints (such as events_properties and segments) are paginated. The response includes a cursor object in the metadata section:

after: Cursor for fetching the next set of results.
before: Cursor for fetching previous results (if available).
limit: Number of results per request.
total_count: Total number of available records.

Example Paginated Request

curl --location 'https://appex.userpilot.io/api/v1/analytics/exports/lookups/events_properties?after_cursor=...' \
--header 'Authorization: Token {{API_KEY}}'

Example Paginated Response

{
    "data": [ ... ],
    "metadata": {
        "cursor": {
            "after": "...",
            "before": null
        },
        "limit": 50,
        "total_count": 53
    }
}

Always check if cursor.after exists in the response before making the next request.
If cursor.after is null, you have reached the last page of data.
To modify the number of results per request, use the limit parameter in your query string (default is 50).

For any questions or concerns please reach out to support@userpilot.com

APIs

Real-time HTTP

Bulk Identify/Update

Bulk Import

Bulk Export

Email Subscriptions

Bulk Delete

User & Company

Features & Events

Experiences & UI

How to Use

Example Response

Example Paginated Request

Example Paginated Response

​User & Company

​Features & Events

​Experiences & UI

​How to Use

​Example Response

​Pagination

​Example Paginated Request

​Example Paginated Response

User & Company

Features & Events

Experiences & UI

How to Use

Example Response

Pagination

Example Paginated Request

Example Paginated Response