Sign in

v1

latestOpenAPI 3.0.32026-07-248519153.1 KB

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: Performance of campaigns.
get/reports/getGraph

Query parameters

projectinteger required

The project ID for which the graph is being retrieved.

functions[]string[] required

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

quizzes[]string[]

Optional list of quiz IDs for filtering.

paywalls[]string[]

Optional list of paywall IDs for filtering.

quizzesVersion[]string[]

Optional list of quiz versions for filtering.

fromstring date required

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

tostring date required

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

utm_source[]string[]

Optional UTM source for filtering.

utm_medium[]string[]

Optional UTM medium for filtering.

utm_campaign[]string[]

Optional UTM campaign for filtering.

utm_content[]string[]

Optional UTM content for filtering.

utm_term[]string[]

Optional UTM term for filtering.

utm_grouping'source_campaign_medium' | 'source_medium_campaign' | 'source_campaign_content' | 'source_campaign_content_term'

UTM grouping order for utmReport function.

Response

Graph data retrieved successfully

successinteger
functionsobject

Example response

{
  "success": 1
}