Créer une clé de télémétrie
Creates a new telemetry key for the title.
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| TelemetryKeyAlreadyExists | 14202 |
| TelemetryKeyCountOverLimit | 14204 |
| TelemetryKeyInvalidName | 14201 |
| TelemetryKeyLongInsightsRetentionNotAllowed | 14206 |
POST
/
Event
/
CreateTelemetryKey
Create Telemetry Key
curl --request POST \
--url https://{titleId}.playfabapi.com/Event/CreateTelemetryKey \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"KeyName": "MyTelemetryKey"
}
'import requests
url = "https://{titleId}.playfabapi.com/Event/CreateTelemetryKey"
payload = { "KeyName": "MyTelemetryKey" }
headers = {
"X-EntityToken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({KeyName: 'MyTelemetryKey'})
};
fetch('https://{titleId}.playfabapi.com/Event/CreateTelemetryKey', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{titleId}.playfabapi.com/Event/CreateTelemetryKey",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'KeyName' => 'MyTelemetryKey'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-EntityToken: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{titleId}.playfabapi.com/Event/CreateTelemetryKey"
payload := strings.NewReader("{\n \"KeyName\": \"MyTelemetryKey\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-EntityToken", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Event/CreateTelemetryKey")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"KeyName\": \"MyTelemetryKey\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Event/CreateTelemetryKey")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"KeyName\": \"MyTelemetryKey\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"NewKeyDetails": {
"Name": "MyTelemetryKey",
"KeyValue": "PLACEHOLDER",
"IsActive": true,
"CreateTime": "2023-02-14T12:00:00Z",
"LastUpdateTime": "2023-02-14T12:00:00Z"
}
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}Autorisations
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Corps
application/json
The name of the new key. Telemetry key names must be unique within the scope of the title.
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
The optional entity to perform this action on. Defaults to the currently logged in entity.
Show child attributes
Show child attributes
Réponse
The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.
The Http status code as a string.
Show child attributes
Show child attributes
Exemple:
{
"NewKeyDetails": {
"Name": "MyTelemetryKey",
"KeyValue": "PLACEHOLDER",
"IsActive": true,
"CreateTime": "2023-02-14T12:00:00Z",
"LastUpdateTime": "2023-02-14T12:00:00Z"
}
}
Dernière modification le 6 octobre 2026
Cette page vous a-t-elle été utile ?
⌘I
Create Telemetry Key
curl --request POST \
--url https://{titleId}.playfabapi.com/Event/CreateTelemetryKey \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"KeyName": "MyTelemetryKey"
}
'import requests
url = "https://{titleId}.playfabapi.com/Event/CreateTelemetryKey"
payload = { "KeyName": "MyTelemetryKey" }
headers = {
"X-EntityToken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({KeyName: 'MyTelemetryKey'})
};
fetch('https://{titleId}.playfabapi.com/Event/CreateTelemetryKey', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{titleId}.playfabapi.com/Event/CreateTelemetryKey",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'KeyName' => 'MyTelemetryKey'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-EntityToken: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{titleId}.playfabapi.com/Event/CreateTelemetryKey"
payload := strings.NewReader("{\n \"KeyName\": \"MyTelemetryKey\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-EntityToken", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Event/CreateTelemetryKey")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"KeyName\": \"MyTelemetryKey\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Event/CreateTelemetryKey")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"KeyName\": \"MyTelemetryKey\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"NewKeyDetails": {
"Name": "MyTelemetryKey",
"KeyValue": "PLACEHOLDER",
"IsActive": true,
"CreateTime": "2023-02-14T12:00:00Z",
"LastUpdateTime": "2023-02-14T12:00:00Z"
}
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}