Engagement Payouts v1

Reference for the Engagement Payouts v1 endpoints on Roblox.

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

Endpoints

Method	Path	Name
GET	/v1/universe-payout-history	getUniversePayoutHistory

getUniversePayoutHistory

GET /v1/universe-payout-history

Gets the engagement payout history for a specific universe and a given date range, specified by start and end dates.

Usage

import { fetchApi } from 'rozod';
import { getUniversePayoutHistory } from 'rozod/endpoints/engagementpayoutsv1';

const data = await fetchApi(getUniversePayoutHistory, {
  universeId: /* integer */,
  startDate: /* string */,
  endDate: /* string */
});

Parameters

Name	Type	Required	Description
universeId	integer	Yes	The ID of the universe in question.
startDate	string	Yes	The first date in the range, specified as yyyy-MM-dd.
endDate	string	Yes	The last date in the range, specified as yyyy-MM-dd.

Response

Field	Type	Description
engagementScore	number
payoutInRobux	number
payoutType	string
eligibilityType	string

Errors

Status	Description
400	1: InvalidUniverseId 2: InvalidStartDate 3: InvalidEndDate 4: InvalidDateRange 5: Forbidden 6: TooManyDays
401	0: Authorization has been denied for this request.

---