Skip to main content

How to use the Metrics API

  1. Set up authentication:

    • Get your API key from your Organization settings in GameAnalytics.
    • Use it in your authorization header for all requests (EXAMPLE. I'm a bit confused on what example should I have here)

  2. Check data availability: Use the /metrics/v1/interval endpoint to get the latest available timestamps.

  3. Explore your options:

    • List your games: Use /metrics/v1/games to find the game IDs you’ll need in later requests.
    • Explore dimensions & values: Query /metrics/v1/dimensions and /metrics/v1/dimensions/dimension→/values to explore filters like platform, country, or build version.

  4. Choose your metric endpoint and construct the query body. Each metric has its own dedicated endpoint, e.g. ARPPU → EXAMPLE. You can find a full list of metrics available to query here

info

All data is accessed through RESTful endpoints and returned in JSON format.

{
  "interval": "2025-07-01/P1W",
  "granularity": "day",
  "query": {
    "type": "group",
    "dimension": "country_code",
    "limit": 100
}

Query Options​

IntervalThe time range for your query, specified in ISO-8601 format (e.g., 2025-07-01/P1W means one week starting from July 1st 2025).
GranularityHow the data is aggregated over time. Options include day, week, and all (which aggregates everything into a single value).
QueryDescribes how to group the results. See endpoint documentation for a complete list of parameters.
Query type
  • Group: Aggregates results by a single dimension (similar to an SQL group by clause). This is typically faster than a split query.
  • Split: Groups results by two dimensions. E.g. Grouping by country_code and platform.
  • Timeseries: Returns metrics grouped by the granularity selected.

Using Postman with Metrics API​

Postman is a free tool that lets you send API requests and see the results, without writing any code. It’s a quick way to test and explore Metrics API.

  1. Download Postman or use the online tools
  2. Create a workspace in Postman.
  3. Import the GameAnalytics Metrics API Specification file as a Postman collection.
  4. Set your API key to the collection you just imported. For ease of use, you can set this as a global variable.
  5. Browse through the different metric query examples, and set up your query. Don’t forget to change the interval date range.
  6. Run the request to get your results.