Create an endpoint

  1. Create your endpoint

    Required

    Once you have your insight or SQL query, create an endpoint from it. This will give you a stable API endpoint you can call to retrieve the data.

    From an existing insight:

    1. Open your insight
    2. Click on the info & actions button (the three dots button in the top right)
    3. Click Create endpoint
      Creating an endpoint from an insight

    From the Endpoints page:

    1. Go to the Endpoints page and click New endpoint > Insight-based endpoint
    2. Select an existing insight from the list, or create a new one

    Once you've selected your insight:

    1. Give your endpoint a descriptive name and optionally a description
    • Recommended - daily_active_users, account_users_activity, signup_funnel
    • Avoid - endpoint1, test, query
    1. Create the endpoint

  2. Verify endpoint data

    Recommended

    Before integrating your endpoint into your application, use the Playground tab to verify it returns the expected data.

    1. Open your endpoint from the Endpoints page

    2. Click the Playground tab

      Endpoint playground tab

    3. If your endpoint has variables, enter test values

    4. Click Execute endpoint to retrieve the data

    5. Review the results to understand the response structure

  3. Next step

    Now retrieve data from your endpoint using your preferred language.

    Retrieve your data

Community questions

Was this page useful?

Questions about this page? or post a community question.