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.

Request format

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

Required parameters

Parameters	Purpose
api_key	Your 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.
columns	A comma-separated list of columns for the report See the allowed columns below. For example, day,html_name,impressions.
start1	The start date of the report Accepts a date in YYYY-MM-DD format. For example, 2012-10-05.
end1	The end date of the report Accepts a date in YYYY-MM-DD format. For example, 2012-10-05.

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

Optional parameters

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

Available Columns

General

Column name	Contains
asset_id	The unique identifier for the HTML asset
average_duration	Trimmed mean duration of HTML impressions (in seconds)
country	The 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, , , , )

HTML status

Column name	Contains
html_loading	The total number of times the HTML started loading
html_loaded	The total number of times the HTML successfully loaded
html_displayed	The total number of times the HTML was successfully displayed
html_completed	The total number of times the HTML was fully completed
html_completion_rate	The ratio of html_completed to impressions

Challenge metrics

Column name	Contains
challenge_started	The total number of times the challenge in HTML started
challenge_failed	The total number of times users failed the challenge in HTML
challenge_failed_rate	The ratio of challenge_failed to impressions
challenge_retry	The total number of times users retried the challenge in HTML
challenge_retry_rate	The ratio of challenge_retry to impressions
challenge_solved	The total number of times users solved the challenge in HTML
challenge_solved_rate	The ratio of challenge_solved to impressions
challenge_pass_25	The total number of times users passed 25% of the challenge in HTML
challenge_pass_25_rate	The ratio of challenge_pass_25 to impressions
challenge_pass_50	The total number of times users passed 50% of the challenge in HTML
challenge_pass_50_rate

Redirect metrics

Column name	Contains
cta_clicked	The total number of times the CTA button was clicked
cta_click_rate	The ratio of cta_clicked to impressions
endcard_shown	The total number of endcard shows after the HTML phase
redirect_count	The total number of redirects on the HTML page
redirect_rate	The ratio of redirect_count to impressions

Health metrics

Column name	Contains
black_view_error	The total number of black view errors that occurred on the HTML page
black_view_error_rate	The ratio of black_view_error to impressions
rendering_error	The total number of rendering errors that occurred on the HTML page
rendering_error_rate	The ratio of rendering_error to impressions
runtime_error	The total number of runtime errors that occurred on the HTML page
runtime_error_rate	The 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