GET /analytics-query-api/v1/universes/{universeId}/operations/dimension-values/{operationId} — openapi

Retrieves the result of a long-running dimension values operation.

See the Analytics guide for more information.

Endpoint

Method: GET

Path: /analytics-query-api/v1/universes/{universeId}/operations/dimension-values/{operationId}

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universeId	path	true	The universe ID the operation belongs to.
operationId	path	true	The operation id returned from a prior dimension values request.

[
  {
    "name": "universeId",
    "in": "path",
    "description": "The universe ID the operation belongs to.",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "name": "operationId",
    "in": "path",
    "description": "The operation id returned from a prior dimension values request.",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Responses

Status	Description
200	OK
202	Accepted
400	Bad Request
404	Not Found
429	Too Many Requests
500	Internal Server Error
503	Service Unavailable
504	Gateway Timeout

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/DimensionValuesOperationResult"
        }
      }
    }
  },
  "202": {
    "description": "Accepted",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OperationPending"
        }
      }
    }
  },
  "400": {
    "description": "Bad Request",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/AnalyticsQueryPublicApi.OperationError"
        }
      }
    }
  },
  "404": {
    "description": "Not Found",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/AnalyticsQueryPublicApi.OperationError"
        }
      }
    }
  },
  "429": {
    "description": "Too Many Requests",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/AnalyticsQueryPublicApi.OperationError"
        }
      }
    }
  },
  "500": {
    "description": "Internal Server Error",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/AnalyticsQueryPublicApi.OperationError"
        }
      }
    }
  },
  "503": {
    "description": "Service Unavailable",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/AnalyticsQueryPublicApi.OperationError"
        }
      }
    }
  },
  "504": {
    "description": "Gateway Timeout",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/AnalyticsQueryPublicApi.OperationError"
        }
      }
    }
  }
}

Authentication

{
  "security": [
    {
      "roblox-api-key": []
    },
    {
      "roblox-oauth2": [
        "universe.analytics:read"
      ]
    }
  ],
  "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": [
    "Analytics"
  ],
  "summary": "Retrieves the result of a long-running dimension values operation.",
  "description": "See the <a href=\"https://create.roblox.com/docs/cloud/guides/analytics\">Analytics guide</a> for more information.",
  "parameters": [
    {
      "name": "universeId",
      "in": "path",
      "description": "The universe ID the operation belongs to.",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "operationId",
      "in": "path",
      "description": "The operation id returned from a prior dimension values request.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/DimensionValuesOperationResult"
          }
        }
      }
    },
    "202": {
      "description": "Accepted",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OperationPending"
          }
        }
      }
    },
    "400": {
      "description": "Bad Request",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/AnalyticsQueryPublicApi.OperationError"
          }
        }
      }
    },
    "404": {
      "description": "Not Found",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/AnalyticsQueryPublicApi.OperationError"
          }
        }
      }
    },
    "429": {
      "description": "Too Many Requests",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/AnalyticsQueryPublicApi.OperationError"
          }
        }
      }
    },
    "500": {
      "description": "Internal Server Error",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/AnalyticsQueryPublicApi.OperationError"
          }
        }
      }
    },
    "503": {
      "description": "Service Unavailable",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/AnalyticsQueryPublicApi.OperationError"
          }
        }
      }
    },
    "504": {
      "description": "Gateway Timeout",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/AnalyticsQueryPublicApi.OperationError"
          }
        }
      }
    }
  },
  "x-roblox-stability": "BETA",
  "x-roblox-rate-limits": {
    "perApiKeyOwner": {
      "period": "MINUTE",
      "maxInPeriod": 3000
    },
    "perOauth2Authorization": {
      "period": "MINUTE",
      "maxInPeriod": 3000
    }
  },
  "x-roblox-scopes": [
    {
      "name": "universe.analytics:read",
      "targetResourceSpecifier": "universes"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-api-key": []
    },
    {
      "roblox-oauth2": [
        "universe.analytics:read"
      ]
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/analytics#get_analytics_query_api_v1_universes__universe_id__operations_dimension_values__operation_id_"
  }
}