POST Live telemetry

Increment a counter

Record one or more occurrences in a named counter.

POST /api/v3/{appid}/telemetry/contexts/{contextid}/metrics/{key}/increment

Record one or more occurrences in a named counter.

Use customer-defined keys to keep related counters separate. For example, reaction.primary and reaction.secondary can share a context while producing independent totals.

Request

Parameters

Values in the path and query string.

appid path

string TalkLabs ID required

The TalkLabs application ID assigned to your account.

Example: your-app-id

contextid path

string customer-defined required

A customer defined ID for the live context being measured.

key path

string customer-defined required

A customer defined name for this telemetry signal.

Request

JSON body

Send as application/json.

userId

string customer-defined required

The user expressing the reaction. Used for distinct user weighting and abuse limiting.

by

integer · int64

How many occurrences to add. Defaults to 1; values <= 0 are treated as 1.

Request example

{
  "userId": "u-8842",
  "by": 1
}

Response

Status codes

Every JSON response uses the API result envelope.

200 OK ApiResult

400 Bad Request ApiResult

403 Forbidden ApiResult

500 Internal Server Error ApiResult

curl --request POST \
  --url "https://api.sportstalk247.com/api/v3/${APP_ID}/telemetry/contexts/${CONTEXT_ID}/metrics/${KEY}/increment" \
  --header "Accept: application/json" \
  --header "x-api-token: ${TALKLABS_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "userId": "u-8842",
  "by": 1
}'

const appId = process.env.TALKLABS_APP_ID;
const contextid = '<contextid>';
const key = '<key>';

const response = await fetch(
  `https://api.sportstalk247.com/api/v3/${appId}/telemetry/contexts/${contextid}/metrics/${key}/increment`,
{
  method: 'POST',
  headers: {
    Accept: 'application/json',
    'x-api-token': process.env.TALKLABS_API_TOKEN,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "userId": "u-8842",
  "by": 1
}),
});

const result = await response.json();

import json
import os
import requests

app_id = os.environ["TALKLABS_APP_ID"]
contextid = "<contextid>"
key = "<key>"

response = requests.post(
    f"https://api.sportstalk247.com/api/v3/{app_id}/telemetry/contexts/{contextid}/metrics/{key}/increment",
    headers={
        "Accept": "application/json",
        "x-api-token": os.environ["TALKLABS_API_TOKEN"],
    },
    json=json.loads(r'''{
  "userId": "u-8842",
  "by": 1
}'''),
)
response.raise_for_status()
result = response.json()

Environment variables TALKLABS_APP_ID TALKLABS_API_TOKEN

Response