Away 11:34 PM

3 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

GET /v1/universes/{universeId}/stats — openapi

Get statistics data for a universe.

Endpoint

Method: GET

Path: /v1/universes/{universeId}/stats

Servers:

Parameters

NameLocationRequiredDescription
universeIdpathtrueThe universe id.
Typequerytrue
StartTimequerytrue
EndTimequerytrue
 
[
  {
    "in": "path",
    "name": "universeId",
    "description": "The universe id.",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "in": "query",
    "name": "Type",
    "required": true,
    "schema": {
      "type": "string",
      "enum": [
        "PremiumUpsells",
        "PremiumVisits"
      ]
    }
  },
  {
    "in": "query",
    "name": "StartTime",
    "required": true,
    "schema": {
      "type": "string",
      "format": "date-time"
    }
  },
  {
    "in": "query",
    "name": "EndTime",
    "required": true,
    "schema": {
      "type": "string",
      "format": "date-time"
    }
  }
]

Responses

StatusDescription
200OK
4001: The Universe is invalid. 3: Too many data points requested. 4: The requested data type is not known.
4010: Authorization has been denied for this request. 2: Not authorized to perform this action.
 
{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.EconomyCreatorStats.Api.Models.StatisticsResponse"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.EconomyCreatorStats.Api.Models.StatisticsResponse"
        }
      }
    }
  },
  "400": {
    "description": "1: The Universe is invalid.\r\n3: Too many data points requested.\r\n4: The requested data type is not known."
  },
  "401": {
    "description": "0: Authorization has been denied for this request.\r\n2: Not authorized to perform this action."
  }
}

Authentication

{
  "security": [
    {
      "roblox-legacy-cookie": []
    }
  ],
  "securitySchemes": {
    "roblox-api-key": {
      "type": "apiKey",
      "description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
      "name": "x-api-key",
      "in": "header"
    },
    "roblox-legacy-cookie": {
      "type": "apiKey",
      "description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
      "in": "cookie",
      "name": ".ROBLOSECURITY"
    },
    "roblox-oauth2": {
      "type": "oauth2",
      "description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
      "flows": {
        "authorizationCode": {
          "authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
          "tokenUrl": "https://apis.roblox.com/oauth/v1/token",
          "refreshUrl": "https://apis.roblox.com/oauth/v1/token",
          "scopes": {}
        }
      }
    }
  }
}

Complete Operation Definition

{
  "tags": [
    "Universes"
  ],
  "summary": "Get statistics data for a universe.",
  "parameters": [
    {
      "in": "path",
      "name": "universeId",
      "description": "The universe id.",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "in": "query",
      "name": "Type",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "PremiumUpsells",
          "PremiumVisits"
        ]
      }
    },
    {
      "in": "query",
      "name": "StartTime",
      "required": true,
      "schema": {
        "type": "string",
        "format": "date-time"
      }
    },
    {
      "in": "query",
      "name": "EndTime",
      "required": true,
      "schema": {
        "type": "string",
        "format": "date-time"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.EconomyCreatorStats.Api.Models.StatisticsResponse"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.EconomyCreatorStats.Api.Models.StatisticsResponse"
          }
        }
      }
    },
    "400": {
      "description": "1: The Universe is invalid.\r\n3: Too many data points requested.\r\n4: The requested data type is not known."
    },
    "401": {
      "description": "0: Authorization has been denied for this request.\r\n2: Not authorized to perform this action."
    }
  },
  "servers": [
    {
      "url": "https://economycreatorstats.roblox.com"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-legacy-cookie": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/universes#economycreatorstats_get_v1_universes__universeId__stats"
  }
}