Error reporting

The Error Reporting API lets you programmatically read the error logs your experience produces and control how those errors are grouped. This API supports:

• Fetching details, such as the message, stack trace, severity, platform, and first-seen version, for specific errors.
• Creating, listing, updating, reordering, and deleting rules that group or ignore matching error messages.
• Reviewing Roblox-suggested grouping rules and dismissing the ones you don't want.

Before using this API, you must generate an API key for your experience. When creating the key, add your experience to Access Permissions and grant it the following operations:

Include the key in the x-api-key request header on every request. The key's owner must also have analytics access to the experience; otherwise requests return 403.

All endpoints use your universe ID, which you can find on the Creator Dashboard by selecting your experience and copying the Universe ID from the overview page.

Endpoints

All paths are relative to https://apis.roblox.com. Each endpoint allows up to 60 requests per minute per API key.

Get error details

Each distinct error is identified by a message hash. To get message hashes, query the ErrorCount metric broken down by the MessageHash dimension. See Analytics.

To get details for one or more errors:

1. Copy the API key to the x-api-key request header.
2. Replace ${UniverseId} in the URL with your experience's universe ID.
3. Add one messageHashIds parameter for each error.
4. Optionally narrow the results by time, place, or place version.
5. Send a GET request.

curl --location 'https://apis.roblox.com/universe-performance-raqi/v1/events/logging/universe/${UniverseId}/log-details?messageHashIds=${MessageHash1}&messageHashIds=${MessageHash2}&startTime=2026-10-07T00:00:00Z&endTime=2026-10-08T00:00:00Z' \
--header 'x-api-key: ${ApiKey}'

{
  "values": [
    {
      "id": "1849204477",
      "logSeverity": "Error",
      "logSource": "Server",
      "os": "Windows",
      "platform": "Computer",
      "message": "ServerScriptService.Inventory:42: attempt to index nil with 'Value'",
      "stacktrace": "Script 'ServerScriptService.Inventory', Line 42\nScript 'ServerScriptService.Main', Line 10",
      "firstSeenUtc": "2026-10-07T03:15:00Z",
      "firstSeenPlaceVersion": null
    }
  ]
}

An error that has no logs matching the time range and filters is omitted from values; it isn't returned as an error.

Query parameters

Response fields

Group and ignore errors with rules

Rules let you control how error messages are counted. Each rule is a regular expression plus an operation:

Your rules are evaluated in order, and the first matching rule wins. Rules apply as new errors are processed and don't change errors that were already recorded. Changes can take a few minutes to take effect.

Rule statuses

Create a rule

To create a rule:

1. Copy the API key to the x-api-key request header.
2. Set universeId to your experience's universe ID.
3. Set pattern to a regular expression matching the error message. See Pattern rules.
4. Optionally set output to the label used when regexOperation is Group.
5. Set regexOperation to Group or Ignore.
6. Send a POST request.

curl --location --request POST 'https://apis.roblox.com/log-attribute-http-service/v1/universe-regexes' \
--header 'x-api-key: ${ApiKey}' \
--header 'Content-Type: application/json' \
--data '{
    "universeId": ${UniverseId},
    "pattern": "^Player \\w+ not found$",
    "output": "Player <name> not found",
    "regexOperation": "Group"
}'

curl --location --request POST 'https://apis.roblox.com/log-attribute-http-service/v1/universe-regexes' \
--header 'x-api-key: ${ApiKey}' \
--header 'Content-Type: application/json' \
--data '{
    "universeId": ${UniverseId},
    "pattern": "^AdService: request timed out",
    "regexOperation": "Ignore"
}'

A successful request returns 200 OK with the rule's position. New rules are added to the end of the list. The response doesn't include the rule's ID; list your rules to get it.

{ "order": 3 }

List rules

To list your rules:

1. Copy the API key to the x-api-key request header.
2. Set universeId to your experience's universe ID.
3. Set status to the rule status you want.
4. Send a GET request.

curl --location 'https://apis.roblox.com/log-attribute-http-service/v1/universe-regexes?universeId=${UniverseId}&status=CreatorCreated' \
--header 'x-api-key: ${ApiKey}'

{
  "universeRegexes": [
    {
      "id": 4821,
      "universeId": 1234567890,
      "regexStatus": "CreatorCreated",
      "pattern": "^Player \\w+ not found$",
      "output": "Player <name> not found",
      "order": 1,
      "regexOperation": "Group",
      "createdTime": "2026-10-01T18:00:00+00:00",
      "updatedTime": "2026-10-01T18:00:00+00:00",
      "matchedCount": null,
      "sampleMessage": null
    }
  ]
}

Rules are returned in evaluation order. matchedCount and sampleMessage are only populated for AutoGenerated rules.

Update a rule

Updates replace the rule's pattern, output, and regexOperation. Send all three: an omitted output is cleared. Updating doesn't change the rule's position.

curl --location --request PUT 'https://apis.roblox.com/log-attribute-http-service/v1/universe-regexes/${RuleId}' \
--header 'x-api-key: ${ApiKey}' \
--header 'Content-Type: application/json' \
--data '{
    "pattern": "^Player \\w+ (not found|left)$",
    "output": "Player <name> unavailable",
    "regexOperation": "Group"
}'

A successful request returns 200 OK with { "order": n }.

Reorder a rule

Because the first matching rule wins, put more specific rules before broader ones. order is 1-based and must be between 1 and the number of rules with the same status.

curl --location --request PUT 'https://apis.roblox.com/log-attribute-http-service/v1/universe-regexes/${RuleId}/reorder' \
--header 'x-api-key: ${ApiKey}' \
--header 'Content-Type: application/json' \
--data '{ "order": 1 }'

A successful request returns 200 OK with the rule's new order.

Dismiss a suggested rule

Moves an AutoGenerated rule to CreatorIgnored. Other rules return 409.

curl --location --request PUT 'https://apis.roblox.com/log-attribute-http-service/v1/universe-regexes/${RuleId}/ignore' \
--header 'x-api-key: ${ApiKey}'

A successful request returns 204 No Content.

Delete a rule

curl --location --request DELETE 'https://apis.roblox.com/log-attribute-http-service/v1/universe-regexes/${RuleId}' \
--header 'x-api-key: ${ApiKey}'

A successful request returns 204 No Content.

Pattern rules

Create and update requests are rejected with 400 if the pattern:

• Is empty or longer than 1,000 characters.
• Isn't a valid .NET regular expression.
• Starts with an unanchored wildcard, such as .*, .+, (.*), or (.+). Start with literal text or ^ instead.
• Nests repeating quantifiers, such as (a+)* or (\w+)+.
• For Ignore rules only: has a top-level alternative that doesn't start with at least 3 literal characters, optionally after ^. For example, ^AdService: is allowed, but ^\w+ and abc|.* are not.

Rule limits

• Each experience can have up to 100 CreatorCreated rules.
• Two rules with the same status can't have the same pattern.

Common errors

Errors return the HTTP status code and a human-readable message. These endpoints don't return machine-readable error codes, so base your error handling on the HTTP status.