Get Telemetry Key
Gets information about a telemetry key configured for the title.
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| TelemetryKeyNotFound | 14200 |
POST
/
Event
/
GetTelemetryKey
Get Telemetry Key
curl --request POST \
--url https://{titleId}.playfabapi.com/Event/GetTelemetryKey \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"KeyName": "MyTelemetryKey"
}
'import requests
url = "https://{titleId}.playfabapi.com/Event/GetTelemetryKey"
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/GetTelemetryKey', 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/GetTelemetryKey",
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/GetTelemetryKey"
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/GetTelemetryKey")
.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/GetTelemetryKey")
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": {
"KeyDetails": {
"Name": "MyTelemetryKey",
"KeyValue": "PLACEHOLDER",
"IsActive": true,
"CreateTime": "2023-02-14T12:00:00Z",
"LastUpdateTime": "2023-02-15T12:00:00Z"
}
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}Authorizations
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Body
application/json
The name of the key to retrieve.
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
Response
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
Example:
{
"KeyDetails": {
"Name": "MyTelemetryKey",
"KeyValue": "PLACEHOLDER",
"IsActive": true,
"CreateTime": "2023-02-14T12:00:00Z",
"LastUpdateTime": "2023-02-15T12:00:00Z"
}
}
Last modified on October 1, 2026
Was this page helpful?
⌘I
Get Telemetry Key
curl --request POST \
--url https://{titleId}.playfabapi.com/Event/GetTelemetryKey \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"KeyName": "MyTelemetryKey"
}
'import requests
url = "https://{titleId}.playfabapi.com/Event/GetTelemetryKey"
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/GetTelemetryKey', 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/GetTelemetryKey",
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/GetTelemetryKey"
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/GetTelemetryKey")
.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/GetTelemetryKey")
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": {
"KeyDetails": {
"Name": "MyTelemetryKey",
"KeyValue": "PLACEHOLDER",
"IsActive": true,
"CreateTime": "2023-02-14T12:00:00Z",
"LastUpdateTime": "2023-02-15T12:00:00Z"
}
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}