跳转到内容

HTML Metrics API

此内容尚不支持你的语言。

The /playableMetrics endpoint provides comprehensive analytics data for HTML ad performance. This API allows you to query asset-level metrics including impressions, user interactions, challenge completion rates, and error tracking.

HTML Metrics API

Request format

Make report requests by sending HTTP GET requests to: https://r.applovin.com/playableMetrics

Required parameters

ParametersPurpose
api_keyYour Report Key
You can find your Report Key on the Axon dashboard by clicking your account in the top right of the dashboard and selecting Keys.
columnsA comma-separated list of columns for the report
See the allowed columns below. For example, day,html_name,impressions.
start1The start date of the report
Accepts a date in YYYY-MM-DD format. For example, 2012-10-05.
end1The end date of the report
Accepts a date in YYYY-MM-DD format. For example, 2012-10-05.

1This API has a request window of 45 days. Ensure the date parameters are in the last 45 days.

Optional parameters

ParametersPurpose
formatThe format for the report
Accepts json or csv. Default: json
day_columnMetrics are cohorted by default; set this to event_day when you want to pull real-time metrics.
limitThe limit on the number of rows you want to return; for example, 500 (use limit and offset to paginate results)
offsetThe offset at which you want to begin fetching rows; for example, 100 (use limit and offset to paginate results)

Available Columns

General

Column nameContains
asset_idThe unique identifier for the HTML asset
average_durationTrimmed mean duration of HTML impressions (in seconds)
countryThe country or region where the impression occurred.
Possible values:
  • US: United States
  • G1: Top-tier countries (GB, CA, AU, DE, FR, JP, KR)
  • G2: Mid-tier countries (CN, TW, CH, NO, SE, FI, HK, SG, IE, NZ, AT, BE, DK, IT, LU, NL, ES)
  • ROW: Rest of World
dayThe report date in YYYY-MM-DD format. For example, 2012-10-05
device_modelThe device model on which the HTML was shown. Includes the top 100 models per manufacturer. Possible values: apple_promax13, samsung_sma035f, tecno_tecnokh7
html_nameThe name of the HTML asset
impressionsThe total number of impressions
original_urlThe URL to the uploaded HTML file
os_versionThe major version of the operating system. Possible values: 14, 15, 16
platformThe platform on which the HTML was shown. Possible values: ANDROID, IOS
spendThe total amount of spend
total_interactionsThe total number of user interactions with your HTML, including all touch actions
unique_interactionsThe total number of user interactions with your HTML, including all touch actions, deduplicated per impression
unique_interactions_rateThe ratio of unique_interactions to impressions
unique_redirectsThe total number of clicks in your HTML that redirected users to the app store, counted once per impression
unique_redirects_rateThe ratio of unique_redirects to impressions

HTML status

Column nameContains
html_loadingThe total number of times the HTML started loading
html_loadedThe total number of times the HTML successfully loaded
html_displayedThe total number of times the HTML was successfully displayed
html_completedThe total number of times the HTML was fully completed
html_completion_rateThe ratio of html_completed to impressions

Challenge metrics

Column nameContains
challenge_startedThe total number of times the challenge in HTML started
challenge_failedThe total number of times users failed the challenge in HTML
challenge_failed_rateThe ratio of challenge_failed to impressions
challenge_retryThe total number of times users retried the challenge in HTML
challenge_retry_rateThe ratio of challenge_retry to impressions
challenge_solvedThe total number of times users solved the challenge in HTML
challenge_solved_rateThe ratio of challenge_solved to impressions
challenge_pass_25The total number of times users passed 25% of the challenge in HTML
challenge_pass_25_rateThe ratio of challenge_pass_25 to impressions
challenge_pass_50The total number of times users passed 50% of the challenge in HTML
challenge_pass_50_rateThe ratio of challenge_pass_50 to impressions
challenge_pass_75The total number of times users passed 75% of the challenge in HTML
challenge_pass_75_rateThe ratio of challenge_pass_75 to impressions

Redirect metrics

Column nameContains
cta_clickedThe total number of times the CTA button was clicked
cta_click_rateThe ratio of cta_clicked to impressions
endcard_shownThe total number of endcard shows after the HTML phase
redirect_countThe total number of redirects on the HTML page
redirect_rateThe ratio of redirect_count to impressions

Health metrics

Column nameContains
black_view_errorThe total number of black view errors that occurred on the HTML page
black_view_error_rateThe ratio of black_view_error to impressions
rendering_errorThe total number of rendering errors that occurred on the HTML page
rendering_error_rateThe ratio of rendering_error to impressions
runtime_errorThe total number of runtime errors that occurred on the HTML page
runtime_error_rateThe ratio of runtime_error to impressions

Filtering columns

You can filter reports by any column. When you do so, you search for a direct match to any of the filters.

To filter by a column, add the following URL parameter: filter_columnname=onefilter,anotherfilter,thirdfilter

For example, if you want to see data only for the Android platform, set the following URL parameter: filter_platform=ANDROID

See the table above for a list of all columns.

Sorting columns

You sort reports in a similar way to how you filter reports.

For example, to sort a report by campaign, add the following URL parameter: sort_campaign=ASC

The accepted values are ASC for ascending or DESC for descending. All sorts are lexicographical sort.

Time Zone

All data in the reporting API is in UTC (Coordinated Universal Time).

Example Request

https://r.applovin.com/playableMetrics?api_key=«your-report-key»&start=2025-10-27&end=2025-10-27&columns=day,asset_id,html_name,impressions,unique_interactions&format=json&limit=100&sort_impressions=desc