Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14,528 changes: 0 additions & 14,528 deletions package-lock.json

This file was deleted.

46 changes: 0 additions & 46 deletions package.json

This file was deleted.

2 changes: 1 addition & 1 deletion versioned_docs/version-3.0/arr.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ metadataTitle: "Understanding Annual Recurring Revenue (ARR) | Adapty Docs"
import Zoom from 'react-medium-image-zoom';
import 'react-medium-image-zoom/dist/styles.css';

The Annual recurring revenue chart shows revenue from all active auto-renewable subscriptions normalized to one year. The chart considers any paid, unexpired subscription as active. ARR is a crucial metric for tracking your subscription business's growth and predicting future revenue.
The Annual recurring revenue chart shows revenue from all active auto-renewable subscriptions normalized to one year. The chart considers any paid, unexpired subscription as active. ARR is a crucial metric for tracking your subscription business's growth and predicting future revenue.


<Zoom>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
---
title: "Server-side API"
title: "Getting started with server-side api"
description: "Get started with Adapty’s server-side API for subscription management."
metadataTitle: "Getting Started with Server-Side API | Adapty Docs"
metadataTitle: "Getting Started with server-Side API | Adapty Docs"

---

import Zoom from 'react-medium-image-zoom';
import 'react-medium-image-zoom/dist/styles.css';

Adapty's server-side API empowers you to programmatically access and manage your subscription data, enabling seamless integration with your existing services and infrastructure. Whether you're syncing data across platforms, granting access levels, or validating purchases in Stripe, this API provides the tools to keep your systems in sync and your users engaged.

With the API, you can:

1. Check a user's subscription status.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 33 additions & 5 deletions versioned_docs/version-3.0/installation-of-adapty-sdks.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,42 @@ metadataTitle: "Installing Adapty SDKs | Adapty Docs"

import Zoom from 'react-medium-image-zoom';
import 'react-medium-image-zoom/dist/styles.css';
import SampleApp from '@site/src/components/reusable/SampleApp.md';
import SampleApp from '@site/src/components/reusable/SampleApp.md';

Adapty comprises two crucial SDK modules for seamless integration into your mobile app:
<img src = "https://camo.githubusercontent.com/e58b312c50330077d2570b9431cc838b7d4849b3c826913bd1d85f32e43e40f6/68747470733a2f2f6164617074792d706f7274616c2d6d656469612d70726f64756374696f6e2e73332e616d617a6f6e6177732e636f6d2f6769746875622f6164617074792d736368656d612e706e67" style={{ width: "100%" }}/>

- Main **AdaptySDK**: This is a fundamental, mandatory SDK necessary for the proper functioning of Adapty within your app.
- **AdaptyUI SDK**: This optional module becomes necessary if you use the Adapty Paywall Builder, a user-friendly, no-code tool for easily creating cross-platform paywalls. These paywalls are built in a visual constructor right in our dashboard, run entirely natively on the device, and require minimal effort from you to create something that performs well.
Adapty's SDK provides a complete set of tools for integrating the Adapty platform into your mobile app. To download the SDK, use one of the following links:

The Adapty SDK installation and configuration depend on your framework, so refer to the following doc topics for detailed guidance:
- [iOS](https://github.com/adaptyteam/AdaptySDK-iOS)
- [Android](https://github.com/adaptyteam/AdaptySDK-Android)
- [Flutter](https://github.com/adaptyteam/AdaptySDK-Flutter)
- [React Native](https://github.com/adaptyteam/AdaptySDK-React-Native)
- [Unity](https://github.com/adaptyteam/AdaptySDK-Unity)

To download the latest version of the SDK:
1. Click the **\<\> Code** button on the repository page, copy the URL to your clipboard, and run `git clone <copied_url>` in your terminal. If you are developing an iOS app and using Xcode, you don’t need to download the SDK from GitHub.
2. Alternatively, navigate to the **Releases** section (located in the right panel on GitHub), select the release you need, and download the `.zip` or `.tar.gz` archive.

:::info
If you’re using an older version of Adapty SDK and want to upgrade to version 3.x, we recommend following our [Migration guide to Adapty SDK v.3.x or later](migration-to-adapty-sdk-v3).
:::

## What's Included in Adapty's SDKs

All Adapty SDKs include the following components:

- **Core SDK: Adapty**
This is the main SDK required for the proper functioning of Adapty within your app.

- **Optional SDK: AdaptyUI**
This SDK is necessary if you use the Adapty Paywall Builder—a user-friendly, no-code tool for creating cross-platform paywalls. These paywalls are designed using a visual constructor directly in the Adapty dashboard, run natively on the device, and require minimal effort to create high-performing designs.

- **Adapty Demo Apps**
These demo apps are designed to demonstrate how to work with paywalls in Adapty. With minimal functionality, they serve as both a tutorial and a practical example. This section includes apps that utilize paywalls created with the Paywall Builder.

## Installation and Configuration

Follow the instructions provided in the respective repositories to install and configure the SDK for your platform.

- [iOS](sdk-installation-ios)
- [Android](sdk-installation-android)
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-3.0/new-trials.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ metadataTitle: "Managing New Trials in Adapty | Adapty Docs"
import Zoom from 'react-medium-image-zoom';
import 'react-medium-image-zoom/dist/styles.css';

The new trial chart displays the number of activated trials during the selected time period.
The new trials chart displays the number of activated trials during the selected time period.


<Zoom>
Expand Down
135 changes: 67 additions & 68 deletions versioned_docs/version-3.0/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,69 +7,27 @@ metadataTitle: "Adapty Documentation Overview | Adapty Docs"
import Zoom from 'react-medium-image-zoom';
import 'react-medium-image-zoom/dist/styles.css';

[Overview](https://app.adapty.io/overview) is a section of Adapty Dashboard that allows you to see multiple metrics in a single place. You can customize which charts you would like to see and view data for all of your apps at once (unlike in [Charts](charts) which you can use to dive deeper into a particular app).
Overview is a section of the Adapty dashboard that provides analytical information through various chart views. This section includes the following parts:
1. [Control panel](#control-panel-of-the-overview-section) of the Overview section.
1. [Money](#money-analytics-section) analytics section.
1. [Subscribers](#subscribers-analytics-section) analytics section.
1. [Conversion](#conversion-analytics-section) analytics section.
1. [Issues](#issues-analytics-section) analytics section.

It's located right under Home in the left-side menu:
The Overview section provides a high-level analytics view. For detailed information, refer to the [Analytics](https://app.adapty.io/analytics/charts/) section.

## Control panel of the Overview section

<Zoom>
<img src={require('./img/016b5bb-CleanShot_2024-01-22_at_18.38.162x.webp').default}
style={{
border: '1px solid #727272', /* border width and color */
width: '700px', /* image width */
display: 'block', /* for alignment */
margin: '0 auto' /* center alignment */
}}
/>
</Zoom>





## Charts

Overview has the following charts available (you can click on the name to learn more about how we calculate it):

- [Revenue](revenue)
- [MRR](mrr)
- [ARR](arr)
- [ARPPU](arppu)
- [New trials](new-trials)
- [New subscriptions](reactivated-subscriptions)
- [Active trials](active-trials)
- [Active subscriptions](active-subscriptions)
- [New non-subscriptions](non-subscriptions)
- [Refund events](refund-events)
- [Refund money](refund-money)

You can customize which charts to show as well as their order. To do that, press Edit in the top-right corner and then either remove charts you don't need, add more or rearrange existing ones by drag and dropping. You can also customize Overview contents in the "Add" menu:


<Zoom>
<img src={require('./img/d6220fa-CleanShot_2024-01-22_at_20.01.05.gif').default}
style={{
border: '1px solid #727272', /* border width and color */
width: '700px', /* image width */
display: 'block', /* for alignment */
margin: '0 auto' /* center alignment */
}}
/>
</Zoom>





## Controls
:::note

Controls for diving deeper into your data in Overview are very similar to what we have in [Charts](charts) — and most of them are described in [Analytics controls](controls-filters-grouping-compare-proceeds).
All customization options are global for the Overview section and apply to all charts.

There is one important difference though: you can group and filter by country, store, and, most notably, by app — as Overview shows data for all of your apps at once by default. This can be helpful to understand how each of your app contributes to your business metrics:
:::

The Control panel provides a set of tools to customize the view of the Overview section according to your preferences.

<Zoom>
<img src={require('./img/ae3a913-CleanShot_2024-01-22_at_19.56.302x.webp').default}
<img src={require('./img/control-panel.webp').default}
style={{
border: '1px solid #727272', /* border width and color */
width: '700px', /* image width */
Expand All @@ -79,17 +37,58 @@ There is one important difference though: you can group and filter by country, s
/>
</Zoom>

On the left side of the panel, you’ll find the date and grouping tools:
1. **Dropdown calendar** — allows you to select a date range for the analytics displayed in the charts. You can choose from predefined ranges (e.g., last 3 days, last month, last 28 days, last 3 months) or set a custom range. Additionally, you can select the time unit for the charts: day, week, month, quarter, or year.
1. **Compare to** dropdown calendar — enables you to select a previous period for comparison with the current data range. Available presets include: previous period, previous month, previous quarter, previous year, or a custom period. On the chart, the compared data will appear as a differently colored line.
1. The final tool in the data tools set is the **Group by** dropdown list, which allows grouping by: country, store, or app. The charts will display the grouped information accordingly.

On the right side of the panel, you’ll find notification, metric editing, chart display, and data visualization tools:

1. **Email reports** button — redirects to account settings, where you can select the frequency of email reports: daily, weekly, or monthly.
1. **Edit metrics** button — opens additional control tools:
- **+ Add** button — provides a list of Overview metrics that you can choose to display in the section. As an additional feature, you can rearrange the order of charts using drag-and-drop.
- **Count installs** — clicking the dropdown list allows you to select the counting method: counting installs as new device_ids, customer_user_ids, or profiles in Adapty.
- **Time zone** — select your time zone to ensure accurate data.
Once the setup is complete, click the **Done** button to save the new preset.
1. **Chart type** switcher — allows you to change the type of charts. The following chart types are available: stacked column, stacked area, line, 100% stacked column, 100% stacked area, and pie chart.
1. **Revenue data** display switcher — offers three options for displaying revenue data on charts:
- **Gross revenue** — displays the total revenue, including taxes and commission fees from both the App Store and Play Store.
- **Proceeds after store commission** — displays the revenue amount after deducting the store commission fee.
- **Proceeds after store commission and taxes** — displays the revenue amount after deducting both the store commission fee and taxes.
See [Store commission and taxes](controls-filters-grouping-compare-proceeds#store-commission-and-taxes) for more information.

## Money analytics section

This section contains charts reflecting financial metrics, such as:
1. [Revenue](revenue) chart — displays the total revenue earned from both subscriptions and one-time purchases, minus any revenue refunded later.
1. [MRR](mmr) (Monthly Recurring Revenue) chart — displays the normalized revenue generated by your active paid subscriptions on a monthly basis.
1. [ARR](arr) (Annual Recurring Revenue) chart — shows revenue from all active auto-renewable subscriptions, normalized to one year.
1. [ARPU](arpu) (Average Revenue Per User) chart — displays the average revenue generated per user for a given period.
1. [ARPPU](arppu) (Average Revenue Per Paying User) chart — displays the average revenue per paying user.
1. [ARPAS](placement-metrics.md#ARPAS) (Average Revenue Per Active Subscriber) chart — displays the total revenue divided by the number of active subscribers.

## Subscribers analytics section

This section contains charts reflecting subscriber-related metrics, such as:
1. [Installs](installs) chart — shows the total number of users who have installed the app for the first time, as well as reinstalls by existing users.
1. [Active trials](active-trials) chart — displays the number of unexpired free trials that are active at the end of a given period.
1. [New trials](new-trials) chart — displays the number of trials activated during the selected time period.
1. [New subscriptions](reactivated-subscriptions) chart — displays the number of new (first-time activated) subscriptions in your app.
1. [Active subscriptions](active-subscriptions) chart — displays the number of unique paid subscriptions that remain active at the end of each selected period.
1. [Non-subscriptions](non-subscriptions) chart — displays the number of in-app purchases, such as consumables, non-consumables, and non-renewing subscriptions.

## Conversion analytics section

This section contains charts reflecting conversion metrics, such as:
1. **Install → Paid** chart — displays the percentage of users who installed the app on the selected date and later paid for their first subscription (directly, without a trial). If X is the number of installs (consistent across all products since no product is chosen at the installation stage), and Y is the number of those from X who paid, then Conversion = (Y / X) × 100%.
1. **Install → Trial** chart — displays the percentage of users who installed the app on the selected date and later activated a trial. If X is the number of installs (consistent across all products since no product is chosen at the installation stage), and Y is the number of those from X who activated a trial, then Conversion = (Y / X) × 100%.
1. **Trial → Paid** chart — displays the percentage of trials started during the selected period that later converted to paid subscriptions. If X is the number of trials started, and Y is the number of subscriptions activated after those trials, then Conversion = (Y / X) × 100%.

See the [Analytics Conversion](analytics-conversion#main-controls-and-charts) article for detailed information.

## Issues analytics section

This section contains charts reflecting issues-related metrics, such as:
1. [Refund events](refund-events) chart — displays the number of refunded purchases and subscriptions.
1. [Refund money](refund-money) chart — displays the amount of money refunded during the selected period.




:::note
**Timezone and install settings**

Note that these settings apply to all your apps and override what you have in [App settings](general).

- **Installs**: By default, installs are counted by `device_id`—a new installation or reinstallation on a device is counted as a separate install. You can change it by clicking **Edit**. For a detailed explanation of other options, see the [Installs definition for analytics](general#4-installs-definition-for-analytics) section.
- **Timezone**: By default, the timezone for the **Overview** page is inherited from one of your apps. If your apps have different reporting timezones, customize the Overview timezone by clicking **Edit** and selecting the appropriate option from the dropdown.


:::
30 changes: 30 additions & 0 deletions versioned_docs/version-3.0/postman.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: "Working with Postman Collection and Environment"
description: "Explore how to easily start using Adapty's Server-Side API with Postman"
metadataTitle: "Working with Postman Collection and Environment | Adapty Docs"
---

To simplify using our server-side API, we've prepared a Postman collection and an environment file you can download and import into Postman.

- **Request Collection**: Includes all requests available in the Adapty server-side API. Note that it uses variables that you can define in the environment.
- **Environment**: Contains a list of variables where you can define values once. We've prepared a unified environment for the server-side API, web API, and analytics export API to make things easier for you. After making this environment active, Postman will automatically substitute the defined variable values in your requests.

:::tip

[Download the collection and environment](https://raw.githubusercontent.com/adaptyteam/adapty-docs/refs/heads/main/Downloads/Adapty_server_side_API_postman_collection.zip)

:::

For info on how to import a collection and environment to Postman, please refer to the [Postman documentation](https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-data/).

### Variables used

We've created a unified environment for the server-side API, web API, and analytics export API to simplify your workflow. Below are the variables specific to the server-side API:

| Variable | Description | Example Value |
| ----------------------- | ------------------------------------------------------------ | ------------------------------------------------------- |
| secret_api_key | You can find it in the **Secret key** field in the [**App settings**](https://app.adapty.io/settings/general). | `secret_live_Pj1P1xzM.2CvSvE1IalQRFjsWy6csBVNpH33atnod` |
| adapty-customer-user-id | The user ID used in your system. In the Adapty Dashboard, you can find it in the **Customer user ID** field of the Profile. | `john.doe@example.com` |
| adapty-profile-id | The user ID assigned in Adapty. In the Adapty Dashboard, you can find it in the **Adapty ID** field of the Profile. | `3286abd3-48b0-4e9c-a5f6-ac0a006333a6` |
| Adapty-platform | The platform used by the user for your app. Possible values: `iOS`, `macOS`, `iPadOS`, `visionOS`, `Android`, `web`. | `iOS` |
| stripe_token | Token of a Stripe object representing a unique purchase, such as a Subscription (`sub_XXX`) or Payment Intent (`pi_XXX`). | `sub_1JY8xLLy6P12345a` |
Loading