기술 자료

Session Observability Session Observability

Session Observability Session Observability

Session Observability

[Deprecated] This API is deprecated and will be removed on November 1st, 2026. Use Matchmaker logs for matchmaking observability instead.
The Session Observability Service provides visibility into multiplayer sessions.
For a service account to access the admin API, it must be granted the project-level 
Multiplayer Session Details Viewer
role.
Download OpenAPI specification:

Query Session Details

Get a list of session details that fulfill the filter criteria.
[Deprecated] This endpoint will be removed on November 1st, 2026. Use Matchmaker logs for matchmaking observability instead.
Authorizations
ServiceAccount
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string
필수
The ID of the Unity project

environmentId

string
필수
The Environment ID of the given project

Query parameters for "{title}"

poolId

string
The ID of the pool to filter

poolName

string
The name of the pool to filter

queueName

string
The name of the queue to filter

regionId

string
The ID of the allocation region to filter

matchmakingTicketId

string
The ID of the ticket to filter

createdAfter

string
The created date-time of a session detail to filter

updatedAfter

string
The last updated date-time of a session detail to filter

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/session-observability/v1/projects/{projectId}/environments/{environmentId}/sessions"

Response example

[ { "allocation": { "completedAt": "2024-01-01T00:00:00Z", "id": "string", "regionId": "string", "requestedAt": "2024-01-01T00:00:00Z", "serverId": "string", "status": "Unknown" }, "createdAt": "2024-01-01T00:00:00Z", "environmentId": "string", "gameMode": { "poolId": "string", "poolName": "string", "queueId": "string", "queueName": "string" }, "matchmakingStatus": "Unknown", "projectId": "string", "sessionEvents": [ { "appliedRules": [ { "context": null, "externalData": null, "name": null, "not": null, "reference": null, "source": null, "teamId": null, "type": null } ], "teams": [ { "id": null, "name": null, "playerIds": null } ], "timestamp": "2024-01-01T00:00:00Z", "type": "string" } ], "sessionId": "string", "updatedAt": "2024-01-01T00:00:00Z" }]

Get Session Details

Get the full details of a session by its ID.
[Deprecated] This endpoint will be removed on November 1st, 2026. Use Matchmaker logs for matchmaking observability instead.
Authorizations
ServiceAccount
HTTP: ServiceAccount
To get started with authentication, visit the Service Account Authentication section.
HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string
필수
The ID of the Unity project

environmentId

string
필수
The Environment ID of the given project

sessionId

string
필수
The session ID to interact with

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/session-observability/v1/projects/{projectId}/environments/{environmentId}/sessions/{sessionId}"

Response example

{ "allocation": { "completedAt": "2024-01-01T00:00:00Z", "id": "string", "regionId": "string", "requestedAt": "2024-01-01T00:00:00Z", "serverId": "string", "status": "Unknown" }, "createdAt": "2024-01-01T00:00:00Z", "environmentId": "string", "gameMode": { "poolId": "string", "poolName": "string", "queueId": "string", "queueName": "string" }, "matchmakingStatus": "Unknown", "projectId": "string", "sessionEvents": [ { "appliedRules": [ { "context": "string", "externalData": {}, "name": "string", "not": true, "reference": "string", "source": "string", "teamId": "string", "type": "string" } ], "teams": [ { "id": "string", "name": "string", "playerIds": [ null ] } ], "timestamp": "2024-01-01T00:00:00Z", "type": "string" } ], "sessionId": "string", "updatedAt": "2024-01-01T00:00:00Z"}