Admin Integrations

The owners-only Integrations page - each studio game's daily analytics read and the GitHub organization connection, and what to do when either fails.

Panel / Admin pages

The Integrations page (/admin/integrations) says whether the studio's two outside connections work: the daily analytics read from Roblox for each studio game, and the GitHub organization collection. Only organization owners can open it. Each part is its own card, so one that cannot be read leaves the other.

Integrations tiles

Read successfullygames

The accent tile: studio games whose last daily analytics read worked.

Covered by a group keygames

Studio games whose Roblox group is registered with a key on Groups.

Studio gamesgames

Every studio game.

The Game analytics table

Each studio game's numbers (players, retention, revenue and the rest) are read from Roblox once a day with the key of the group that owns the game. Groups and keys on the card opens Admin Groups. Columns:

Game

The game's name, or "Experience" and its id.

Analytics

The status of the last read (below).

Group key

The group whose key covers the game, or None.

Last read

When the last fully successful read finished, or Never.

Detail

The sentence an owner acts on, such as which permission to add. Before the first read it says "The worker reads analytics daily and after it starts."

Analytics statuses: Reading, Waiting, No key, Key refused, Not permitted, Read failed

Reading

Every query of the last read succeeded.

Not read yet

The worker has not looked at this game yet.

Waiting

The read is pending.

No key

No registered group owns the game, so nothing covers it. Its pages say "Not configured".

Key refused

Roblox answered 401: the key is wrong, expired, or lacks universe.analytics:read.

Not permitted

Roblox answered 403: the key may not read this game, or the server's address is not allowed.

Read failed

Anything else: no such game for this key, a query that never finished, Roblox busy or failing after retries, or a key the worker cannot open.

A failed query does not wipe what was read before: Last read keeps the previous full read, and the game's other numbers are still stored.

How a group key reaches a game's analytics

A key covers a game when Roblox lists the game's owner as a group and that group is registered on Groups with its key. A group has one key, so at most one key covers a game. A game owned by a person, not a group, is never covered. Archived studio games are skipped.

For each covered game, one at a time, the daily read:

  1. opens the group's sealed key (the worker alone can);

  2. reads the daily totals (players, retention, playtime, revenue and the rest);

  3. reads the breakdowns by platform, country, age group and acquisition source, unless Roblox refused the key for the totals;

  4. reads the developer products, game passes and bans;

  5. stores what it read, and the game's status and sentence for this page.

Each part records its own result, so one refused part, or one failing game, never stops the others. The Studio pages and each game's hub then read what was stored.

How a group key reaches a game's analytics. The daily read takes each studio game that is not archived and finds the registered group that owns it on Roblox. A game with no such group is marked No key. For a covered game the worker opens the group's sealed key, reads the daily totals, then the breakdowns, then the products, passes and bans, and stores them with the game's status. The Studio pages, the game hub and this page read only what was stored.

When the daily analytics read runs

Once a day, on its own owned-analytics queue, one run at a time across every worker, and once more a minute after the worker starts. The first read of a game goes 90 complete UTC days back (28 for performance numbers and breakdowns); after that each read replaces the last 7 complete days, because Roblox revises recent days. Today is never read half counted. More on what is read: Studio pages.

How to fix a game that is not reading

  1. Read the Detail

    The sentence names the problem, such as a missing permission.

  2. No key

    Register the game's Roblox group with its key on Admin Groups.

  3. Key refused or Not permitted

    Add the missing permission to the key on the Creator Dashboard, or create a new key and use Replace key on Groups. Keep Restrict by Experience off.

  4. Wait for the next read

    The status changes after the next daily read, or after the worker restarts.

The GitHub organization card

The GitHub organization card is the connection the Code pages are collected with: read-only, and separate from Roblox. It has two tiles:

GitHub token or GitHub App

Configured (a token in the deployment), Saved (an App saved here) or Not connected, with the credential's fingerprint.

Last GitHub run

Succeeded, Failed or Not collected, with how long ago, how many requests it sent and how many came back unchanged, and how many seconds it took. Before the first run it says "Checks every 30 minutes".

Under the tiles, the result of the last verification, and, when the last run did not finish, its error with "It tries again every 30 minutes." A run's stored message starts with its kind in brackets, such as [partial] for a run that kept some repositories' previous data, or [circuit-open] while runs are skipped because GitHub kept failing. What a run does and what stops it: What one GitHub collection run does.

GitHub token or GitHub App

The collection uses one of two credentials. A deployment token takes precedence over a saved App.

A read-only token set in the servers' configuration, for the same organization used for sign-in. It cannot be seen or changed in the browser: the card shows only its fingerprint and a Verify token button. A deployment owner replaces it.

How to connect a GitHub App

  1. Prepare the App

    Use an App owned by the organization and installed on all repositories. It needs read access to Organization Members and repository Metadata, Contents, Pull requests, Issues and Administration. Disable webhooks.

  2. Fill in the form

    Enter the App ID, the Installation ID and the Private key (PEM).

  3. Save

    Choose Save App and verify (or Replace App and verify when one is saved). The private key is sealed at rest, cleared from the form, and never shown again.

  4. Verify later

    Verify saved App checks it again at any time.

Verification checks the organization, that the App is installed on every repository and not suspended, that its permissions are read-only, and that it can reach the organization. A verification that passes is not a collection that worked: the Last GitHub run tile says whether collection did.

How to verify the GitHub connection

  1. Open the GitHub card

    On Admin, Integrations, find GitHub organization.

  2. Verify it

    Choose Verify token (a deployment token) or Verify saved App.

  3. Read the result

    The result appears under the tiles. Then check Last GitHub run after the next run, within 30 minutes: a passing verification does not prove a collection worked.

How fresh the Integrations page is

It reads what is stored each time it opens: the analytics state the worker wrote after its last daily read, and the last GitHub run. It asks neither Roblox nor GitHub, except when you choose a verify button.

The Integrations page on a phone

The tiles sit two to a row, and the GitHub form's two id fields stack. The analytics table scrolls sideways; the Detail column is the widest.

Related: Admin pages, Collector and data freshness.

Updated