Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.userpilot.com/llms.txt

Use this file to discover all available pages before exploring further.

The Lookups APIs allow you to retrieve metadata about various entities in your Userpilot account, such as user properties, company properties, features, events, and more. These endpoints help you understand the structure and available fields in your exported data.

​
User & Company

Endpoints for retrieving user and company metadata, as well as segments.
EndpointDescription
/api/v1/analytics/exports/lookups/user_propertiesGet user properties
/api/v1/analytics/exports/lookups/company_propertiesGet company properties
/api/v1/analytics/exports/lookups/segmentsGet segments (paginated)

​
Features & Events

Endpoints for retrieving features, events, and event property metadata.
EndpointDescription
/api/v1/analytics/exports/lookups/features_eventsGet features & events
/api/v1/analytics/exports/lookups/events_propertiesGet trackable events’ properties/attributes (paginated)

​
Experiences & UI

Endpoints for retrieving experiences, UI elements, surveys, resource center modules, and checklists.
EndpointDescription
/api/v1/analytics/exports/lookups/flowsGet flows (experiences)
/api/v1/analytics/exports/lookups/bannersGet banners
/api/v1/analytics/exports/lookups/spotlightsGet spotlights
/api/v1/analytics/exports/lookups/surveysGet surveys (with modules)
/api/v1/analytics/exports/lookups/resource_center_modulesGet resource center modules
/api/v1/analytics/exports/lookups/checklistsGet 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).