Metrics v1

Reference for the Metrics v1 endpoints on Roblox.

Base URL: https://metrics.roblox.com

Endpoints

Method	Path	Name
POST	/v1/bundle-metrics/report	postBundleMetricsReport
POST	/v1/thumbnails/load	postThumbnailsLoad
GET	/v1/thumbnails/metadata	getThumbnailsMetadata

postBundleMetricsReport

POST /v1/bundle-metrics/report

Records bundle load successes.

Usage

import { fetchApi } from 'rozod';
import { postBundleMetricsReport } from 'rozod/lib/endpoints/metricsv1';

const data = await fetchApi(postBundleMetricsReport, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
bundleUrl	string
bundleName	string
loadTimeInMilliseconds	number
cdnProviderName	string
loadState	`0	1
bundleContentType	`0	1

Response

Type: unknown

Errors

Status	Description
400	1: The bundle url is invalid.

---

postThumbnailsLoad

POST /v1/thumbnails/load

Records the time it takes for a thumbnail to get loaded in the UI.

Usage

import { fetchApi } from 'rozod';
import { postThumbnailsLoad } from 'rozod/lib/endpoints/metricsv1';

const data = await fetchApi(postThumbnailsLoad, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
duration	number
loadState	`0	1
thumbnailType	string

Response

Type: unknown

Errors

Status	Description
400	2: A required parameter is missing from the request
403	0: Token Validation Failed

---

getThumbnailsMetadata

GET /v1/thumbnails/metadata

Get metadata related to logging thumbnail load metrics.

Usage

import { fetchApi } from 'rozod';
import { getThumbnailsMetadata } from 'rozod/lib/endpoints/metricsv1';

const data = await fetchApi(getThumbnailsMetadata, undefined);

Response

Field	Type	Description
logRatio	number

---