Ingest telemetry events
curl --request POST \
--url https://api.example.com/v1/telemetry/ingest \
--header 'Content-Type: application/json' \
--data '
{
"events": [
{
"type": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"source": "<string>",
"sessionId": "<string>",
"durationMs": 43200000,
"success": true,
"dimensions": [
{
"type": "<string>",
"label": "<string>",
"value": "<string>",
"metadata": {}
}
]
}
]
}
'import requests
url = "https://api.example.com/v1/telemetry/ingest"
payload = { "events": [
{
"type": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"source": "<string>",
"sessionId": "<string>",
"durationMs": 43200000,
"success": True,
"dimensions": [
{
"type": "<string>",
"label": "<string>",
"value": "<string>",
"metadata": {}
}
]
}
] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
events: [
{
type: '<string>',
timestamp: '2023-11-07T05:31:56Z',
source: '<string>',
sessionId: '<string>',
durationMs: 43200000,
success: true,
dimensions: [{type: '<string>', label: '<string>', value: '<string>', metadata: {}}]
}
]
})
};
fetch('https://api.example.com/v1/telemetry/ingest', 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://api.example.com/v1/telemetry/ingest",
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([
'events' => [
[
'type' => '<string>',
'timestamp' => '2023-11-07T05:31:56Z',
'source' => '<string>',
'sessionId' => '<string>',
'durationMs' => 43200000,
'success' => true,
'dimensions' => [
[
'type' => '<string>',
'label' => '<string>',
'value' => '<string>',
'metadata' => [
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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://api.example.com/v1/telemetry/ingest"
payload := strings.NewReader("{\n \"events\": [\n {\n \"type\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"source\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"durationMs\": 43200000,\n \"success\": true,\n \"dimensions\": [\n {\n \"type\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<string>\",\n \"metadata\": {}\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.example.com/v1/telemetry/ingest")
.header("Content-Type", "application/json")
.body("{\n \"events\": [\n {\n \"type\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"source\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"durationMs\": 43200000,\n \"success\": true,\n \"dimensions\": [\n {\n \"type\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<string>\",\n \"metadata\": {}\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/telemetry/ingest")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"events\": [\n {\n \"type\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"source\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"durationMs\": 43200000,\n \"success\": true,\n \"dimensions\": [\n {\n \"type\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<string>\",\n \"metadata\": {}\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}{
"error": "<string>"
}Telemetry
Ingest telemetry events
Receives a batch of telemetry events from the OpenWork app or workers. Auth provides org and member identity. Unknown event types and disallowed fields are dropped. Always returns 204.
POST
/
v1
/
telemetry
/
ingest
Ingest telemetry events
curl --request POST \
--url https://api.example.com/v1/telemetry/ingest \
--header 'Content-Type: application/json' \
--data '
{
"events": [
{
"type": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"source": "<string>",
"sessionId": "<string>",
"durationMs": 43200000,
"success": true,
"dimensions": [
{
"type": "<string>",
"label": "<string>",
"value": "<string>",
"metadata": {}
}
]
}
]
}
'import requests
url = "https://api.example.com/v1/telemetry/ingest"
payload = { "events": [
{
"type": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"source": "<string>",
"sessionId": "<string>",
"durationMs": 43200000,
"success": True,
"dimensions": [
{
"type": "<string>",
"label": "<string>",
"value": "<string>",
"metadata": {}
}
]
}
] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
events: [
{
type: '<string>',
timestamp: '2023-11-07T05:31:56Z',
source: '<string>',
sessionId: '<string>',
durationMs: 43200000,
success: true,
dimensions: [{type: '<string>', label: '<string>', value: '<string>', metadata: {}}]
}
]
})
};
fetch('https://api.example.com/v1/telemetry/ingest', 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://api.example.com/v1/telemetry/ingest",
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([
'events' => [
[
'type' => '<string>',
'timestamp' => '2023-11-07T05:31:56Z',
'source' => '<string>',
'sessionId' => '<string>',
'durationMs' => 43200000,
'success' => true,
'dimensions' => [
[
'type' => '<string>',
'label' => '<string>',
'value' => '<string>',
'metadata' => [
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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://api.example.com/v1/telemetry/ingest"
payload := strings.NewReader("{\n \"events\": [\n {\n \"type\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"source\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"durationMs\": 43200000,\n \"success\": true,\n \"dimensions\": [\n {\n \"type\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<string>\",\n \"metadata\": {}\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.example.com/v1/telemetry/ingest")
.header("Content-Type", "application/json")
.body("{\n \"events\": [\n {\n \"type\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"source\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"durationMs\": 43200000,\n \"success\": true,\n \"dimensions\": [\n {\n \"type\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<string>\",\n \"metadata\": {}\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/telemetry/ingest")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"events\": [\n {\n \"type\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"source\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"durationMs\": 43200000,\n \"success\": true,\n \"dimensions\": [\n {\n \"type\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<string>\",\n \"metadata\": {}\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}{
"error": "<string>"
}Body
application/json
Required array length:
1 - 50 elementsShow child attributes
Show child attributes
Response
Events accepted.
Was this page helpful?
⌘I