Retrieve reports data for project

Fetch a report based on various parameters such as project, functions, quizzes, paywalls, and time ranges.
This endpoint supports a variety of functions and filters for detailed analytical reporting.
Available functions:

  • totalSubscriptionsAndRevenue: Returns total subscriptions, total revenue, charged revenue, LTV, and average subscription amount.
  • subscriptionsByDay: Provides subscriptions and revenue trends over time.
  • subscriptionsByPriceId: Groups subscriptions by price ID and provides revenue and LTV details.
  • subscriptionsByCountry: Groups subscriptions by country and shows total revenue.
  • subscriptionsByStatus: Breaks down subscriptions by status (e.g., active, incomplete, etc.).
  • dailyCompletionRate: Tracks completion and conversion rates by day.
  • quizFunnel: Provides detailed funnel step conversion rates for quizzes.
  • paywallConversionByDays: Tracks paywall conversion rates by day.
  • paywallFunnel: Shows the paywall funnel conversion breakdown.
  • subscribeToInstallRate: Tracks the rate of rhe percent of users who purchased subscription and installed the app after (meaning - requested subscription status using API).
  • utmReport: Funnel metrics grouped by UTM, country, or platform.
    Default grouping is campaign UTM (source_campaign_medium and related orders).
    Pass utm_grouping=country for a visitor-level country breakdown (user_country_code)
    or utm_grouping=user_platform for a visitor-level platform breakdown (user_platform).
    Both visitor groupings honor quizzes[] and the date range; rows are sorted by users_count descending.
    Visitor metrics (users_count, quizes_started, and earlier funnel steps) use quiz engagement.
    Subscription/revenue columns still attribute via subscription.quiz_id.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
required

The project ID for which the graph is being retrieved.

functions[]
array of strings
required

A list of functions to be included in the graph. Example: totalSubscriptionsAndRevenue.

functions[]*
quizzes[]
array of strings

Optional list of quiz IDs for filtering.

quizzes[]
paywalls[]
array of strings

Optional list of paywall IDs for filtering.

paywalls[]
quizzesVersion[]
array of strings

Optional list of quiz versions for filtering.

quizzesVersion[]
date
required

The start date for the graph data. Example: 2024-11-18.

date
required

The end date for the graph data. Example: 2024-11-25.

utm_source[]
array of strings

Optional UTM source for filtering.

utm_source[]
utm_medium[]
array of strings

Optional UTM medium for filtering.

utm_medium[]
utm_campaign[]
array of strings

Optional UTM campaign for filtering.

utm_campaign[]
utm_content[]
array of strings

Optional UTM content for filtering.

utm_content[]
utm_term[]
array of strings

Optional UTM term for filtering.

utm_term[]
string
enum
Defaults to source_campaign_medium

Grouping dimension for utmReport (ignored by other functions).
UTM orders (source_campaign_medium, source_medium_campaign, source_campaign_content,
source_campaign_content_term) split rows by campaign tags.
country returns one row per user_country_code (visitor geo).
user_platform returns one row per user_platform (ios / android / web, etc.).
Combine with quizzes[], from, and to for a per-quiz visitor breakdown.

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json