Skip to main content

How to use the Organization API

  1. Set up authentication:

    • Get your API key from your Organization settings in GameAnalytics.
    • Use it in your authorization header for all requests.

  2. Set up your API call: Choose the action you would like to do, and set up your parameters.

The API Specification has all endpoints and their functionalities, but here are some common ways the Organization API is used.

List or create studios
  • GET /studios — list all studios
  • POST /studios — create a new studio
List or create games
  • GET /games — list all games (supports pagination, sorting by title, DAU, etc.)
  • POST /games — create a new game, specifying studio_id, title, platform, etc.
Manage Users
  • GET /users — list all users along with their highest access level
  • GET /users/{user_id} — fetch a specific user
  • POST /users/invite — invite one or more users to an organization, studio, or game
  • POST /users/{user_id}/replace_acl — update a user's access permissions (game/studio)
Upload icons
  • POST /images — attach icons to games, studios, or the organization

Common Parameters​

When working with Organization API, you can use several optional parameters to filter, sort and control how data is returned.

  • Filtering: Narrows your results, e.g. to a specific studio ID
  • Pagination: Controls how many results you get per page, e.g. page[size], page[offset]
  • Sorting: Sorts results by a field, e.g. game title
  • Expand Related Objects: Used to get full details of related objects in the same response, e.g. by passing expand[]=studio, you get the full studio object, rather than just the studio id
info

Repeated usage of the API in a short period of time can lead to you being rate-limited. If this happens, your requests will get a 429 Too Many Requests response. Make sure your code can handle that failure scenario and that it's not calling Organization API too often.