PlayStream Events - Create Telemetry Key

Service:

Events

API Version:

240426

Creates a new telemetry key for the title.

POST https://titleId.playfabapi.com/Event/CreateTelemetryKey

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name	Required	Type	Description
KeyName	True	string	The name of the new key. Telemetry key names must be unique within the scope of the title.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity		EntityKey	The optional entity to perform this action on. Defaults to the currently logged in entity.

Responses

Name	Type	Description
200 OK	CreateTelemetryKeyResponse
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
CreateTelemetryKeyRequest
CreateTelemetryKeyResponse
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
TelemetryKeyDetails

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

CreateTelemetryKeyRequest

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity	EntityKey	The optional entity to perform this action on. Defaults to the currently logged in entity.
KeyName	string	The name of the new key. Telemetry key names must be unique within the scope of the title.

CreateTelemetryKeyResponse

Name	Type	Description
NewKeyDetails	TelemetryKeyDetails	Details about the newly created telemetry key.

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name	Type	Description
Id	string	Unique ID of the entity.
Type	string	Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

TelemetryKeyDetails

Name	Type	Description
CreateTime	string	When the key was created.
IsActive	boolean	Whether or not the key is currently active. Deactivated keys cannot be used for telemetry ingestion.
KeyValue	string	The key that can be distributed to clients for use during telemetry ingestion.
LastUpdateTime	string	When the key was last updated.
Name	string	The name of the key. Telemetry key names are unique within the scope of the title.

Error Codes

Name	Code
TelemetryKeyAlreadyExists	14202
TelemetryKeyCountOverLimit	14204
TelemetryKeyInvalidName	14201
TelemetryKeyLongInsightsRetentionNotAllowed	14206