Track an analytics event

curl --request POST \
  --url https://console.cloud.timescale.com/public/api/v1/analytics/track \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "service_created",
  "properties": {
    "region": "us-east-1"
  }
}
'

import requests

url = "https://console.cloud.timescale.com/public/api/v1/analytics/track"

payload = {
    "event": "service_created",
    "properties": { "region": "us-east-1" }
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({event: 'service_created', properties: {region: 'us-east-1'}})
};

fetch('https://console.cloud.timescale.com/public/api/v1/analytics/track', 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://console.cloud.timescale.com/public/api/v1/analytics/track",
  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([
    'event' => 'service_created',
    'properties' => [
        'region' => 'us-east-1'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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://console.cloud.timescale.com/public/api/v1/analytics/track"

	payload := strings.NewReader("{\n  \"event\": \"service_created\",\n  \"properties\": {\n    \"region\": \"us-east-1\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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://console.cloud.timescale.com/public/api/v1/analytics/track")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"event\": \"service_created\",\n  \"properties\": {\n    \"region\": \"us-east-1\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://console.cloud.timescale.com/public/api/v1/analytics/track")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event\": \"service_created\",\n  \"properties\": {\n    \"region\": \"us-east-1\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success"
}

{
  "code": "<string>",
  "message": "<string>"
}

POST

analytics

track

Track an analytics event

curl --request POST \
  --url https://console.cloud.timescale.com/public/api/v1/analytics/track \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "service_created",
  "properties": {
    "region": "us-east-1"
  }
}
'

import requests

url = "https://console.cloud.timescale.com/public/api/v1/analytics/track"

payload = {
    "event": "service_created",
    "properties": { "region": "us-east-1" }
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({event: 'service_created', properties: {region: 'us-east-1'}})
};

fetch('https://console.cloud.timescale.com/public/api/v1/analytics/track', 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://console.cloud.timescale.com/public/api/v1/analytics/track",
  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([
    'event' => 'service_created',
    'properties' => [
        'region' => 'us-east-1'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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://console.cloud.timescale.com/public/api/v1/analytics/track"

	payload := strings.NewReader("{\n  \"event\": \"service_created\",\n  \"properties\": {\n    \"region\": \"us-east-1\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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://console.cloud.timescale.com/public/api/v1/analytics/track")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"event\": \"service_created\",\n  \"properties\": {\n    \"region\": \"us-east-1\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://console.cloud.timescale.com/public/api/v1/analytics/track")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event\": \"service_created\",\n  \"properties\": {\n    \"region\": \"us-east-1\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success"
}

{
  "code": "<string>",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

HTTP Basic Authentication using your Tiger Cloud public key and secret key.

Format: Authorization: Basic <base64(public_key:secret_key)>

Example:

curl -X GET "https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services" \
  -H "Authorization: Basic $(echo -n 'your_public_key:your_secret_key' | base64)"

Body

application/json

event

string

required

The name of the event to track

Example:

"service_created"

properties

object

Optional map of arbitrary properties associated with the event

Example:

{ "region": "us-east-1" }

Response

Analytics action completed successfully.

status

string

Status of the analytics operation

Example:

"success"

Auth

Services

Read Replica Sets

VPCs

Analytics

Track an analytics event

Authorizations

Body

Response