POST /api/v2/web-api/paywall/visit/

Record paywall view

Adapty can help you measure the conversion of your paywalls. However, to do so, it is required for you to log when a paywall gets shown — without that we'd only know about the users who made a purchase and we'd miss those who did not. Use this request to log a paywall view.

Request body

customer_user_idstring

An identifier of a user in your system. Either customer_user_id or profile_id is required.

profile_idstring

An identifier of a user in Adapty. Either customer_user_id or profile_id is required.

visited_atstring

The datetime when the user opened the paywall.

storestringrequired

Store where the product was bought. Possible values: app_store, play_store, stripe, or the Store ID of your custom store.

variation_idstringrequired

The variation ID used to trace purchases to the specific paywall they were made from.

Responses

The paywall view is recorded successfully.

Schema

object

Empty response body

Bad Request

Schema

errorsarray of object

sourcestring

errorsarray of string

error_codestring

status_codeinteger

Unauthorized

Schema

errorsarray of object

sourcestring

errorsarray of string

error_codestring

status_codeinteger

Not Found

Schema

errorsarray of object

sourcestring

errorsarray of string

error_codestring

status_codeinteger

Try it

Authorization

Body

curl --request POST \
  --url 'https://api.adapty.io/api/v2/web-api/paywall/visit/' \
  --header 'Authorization: Api-Key YOUR_PUBLIC_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "visited_at": "2024-08-24T14:15:22Z",
    "store": "app_store",
    "variation_id": "00000000-0000-0000-0000-000000000000",
    "customer_user_id": "user123"
  }'

const response = await fetch('https://api.adapty.io/api/v2/web-api/paywall/visit/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_PUBLIC_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "visited_at": "2024-08-24T14:15:22Z",
    "store": "app_store",
    "variation_id": "00000000-0000-0000-0000-000000000000",
    "customer_user_id": "user123"
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api.adapty.io/api/v2/web-api/paywall/visit/', headers={
    'Authorization': 'Api-Key YOUR_PUBLIC_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "visited_at": "2024-08-24T14:15:22Z",
      "store": "app_store",
      "variation_id": "00000000-0000-0000-0000-000000000000",
      "customer_user_id": "user123"
    })
data = response.json()