Record a usage event
curl --request POST \
--url https://api.example.com/v1/sdk/usages \
--header 'Content-Type: application/json' \
--data '
{
"customerRef": "<string>",
"metadata": {},
"timestamp": "2023-11-07T05:31:56Z",
"actionType": "api_call",
"description": "<string>",
"duration": 1,
"errorMessage": "<string>",
"idempotencyKey": "<string>",
"outcome": "success",
"productRef": "<string>",
"purchaseRef": "<string>",
"units": 1
}
'import requests
url = "https://api.example.com/v1/sdk/usages"
payload = {
"customerRef": "<string>",
"metadata": {},
"timestamp": "2023-11-07T05:31:56Z",
"actionType": "api_call",
"description": "<string>",
"duration": 1,
"errorMessage": "<string>",
"idempotencyKey": "<string>",
"outcome": "success",
"productRef": "<string>",
"purchaseRef": "<string>",
"units": 1
}
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({
customerRef: '<string>',
metadata: {},
timestamp: '2023-11-07T05:31:56Z',
actionType: 'api_call',
description: '<string>',
duration: 1,
errorMessage: '<string>',
idempotencyKey: '<string>',
outcome: 'success',
productRef: '<string>',
purchaseRef: '<string>',
units: 1
})
};
fetch('https://api.example.com/v1/sdk/usages', 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/sdk/usages",
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([
'customerRef' => '<string>',
'metadata' => [
],
'timestamp' => '2023-11-07T05:31:56Z',
'actionType' => 'api_call',
'description' => '<string>',
'duration' => 1,
'errorMessage' => '<string>',
'idempotencyKey' => '<string>',
'outcome' => 'success',
'productRef' => '<string>',
'purchaseRef' => '<string>',
'units' => 1
]),
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/sdk/usages"
payload := strings.NewReader("{\n \"customerRef\": \"<string>\",\n \"metadata\": {},\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"actionType\": \"api_call\",\n \"description\": \"<string>\",\n \"duration\": 1,\n \"errorMessage\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"outcome\": \"success\",\n \"productRef\": \"<string>\",\n \"purchaseRef\": \"<string>\",\n \"units\": 1\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/sdk/usages")
.header("Content-Type", "application/json")
.body("{\n \"customerRef\": \"<string>\",\n \"metadata\": {},\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"actionType\": \"api_call\",\n \"description\": \"<string>\",\n \"duration\": 1,\n \"errorMessage\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"outcome\": \"success\",\n \"productRef\": \"<string>\",\n \"purchaseRef\": \"<string>\",\n \"units\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/sdk/usages")
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 \"customerRef\": \"<string>\",\n \"metadata\": {},\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"actionType\": \"api_call\",\n \"description\": \"<string>\",\n \"duration\": 1,\n \"errorMessage\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"outcome\": \"success\",\n \"productRef\": \"<string>\",\n \"purchaseRef\": \"<string>\",\n \"units\": 1\n}"
response = http.request(request)
puts response.read_body{
"reference": "usage_A1B2C3D4",
"success": true
}Usage
Record a usage event
Records a usage event into the Usage timeseries collection.
POST
/
v1
/
sdk
/
usages
Record a usage event
curl --request POST \
--url https://api.example.com/v1/sdk/usages \
--header 'Content-Type: application/json' \
--data '
{
"customerRef": "<string>",
"metadata": {},
"timestamp": "2023-11-07T05:31:56Z",
"actionType": "api_call",
"description": "<string>",
"duration": 1,
"errorMessage": "<string>",
"idempotencyKey": "<string>",
"outcome": "success",
"productRef": "<string>",
"purchaseRef": "<string>",
"units": 1
}
'import requests
url = "https://api.example.com/v1/sdk/usages"
payload = {
"customerRef": "<string>",
"metadata": {},
"timestamp": "2023-11-07T05:31:56Z",
"actionType": "api_call",
"description": "<string>",
"duration": 1,
"errorMessage": "<string>",
"idempotencyKey": "<string>",
"outcome": "success",
"productRef": "<string>",
"purchaseRef": "<string>",
"units": 1
}
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({
customerRef: '<string>',
metadata: {},
timestamp: '2023-11-07T05:31:56Z',
actionType: 'api_call',
description: '<string>',
duration: 1,
errorMessage: '<string>',
idempotencyKey: '<string>',
outcome: 'success',
productRef: '<string>',
purchaseRef: '<string>',
units: 1
})
};
fetch('https://api.example.com/v1/sdk/usages', 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/sdk/usages",
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([
'customerRef' => '<string>',
'metadata' => [
],
'timestamp' => '2023-11-07T05:31:56Z',
'actionType' => 'api_call',
'description' => '<string>',
'duration' => 1,
'errorMessage' => '<string>',
'idempotencyKey' => '<string>',
'outcome' => 'success',
'productRef' => '<string>',
'purchaseRef' => '<string>',
'units' => 1
]),
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/sdk/usages"
payload := strings.NewReader("{\n \"customerRef\": \"<string>\",\n \"metadata\": {},\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"actionType\": \"api_call\",\n \"description\": \"<string>\",\n \"duration\": 1,\n \"errorMessage\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"outcome\": \"success\",\n \"productRef\": \"<string>\",\n \"purchaseRef\": \"<string>\",\n \"units\": 1\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/sdk/usages")
.header("Content-Type", "application/json")
.body("{\n \"customerRef\": \"<string>\",\n \"metadata\": {},\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"actionType\": \"api_call\",\n \"description\": \"<string>\",\n \"duration\": 1,\n \"errorMessage\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"outcome\": \"success\",\n \"productRef\": \"<string>\",\n \"purchaseRef\": \"<string>\",\n \"units\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/sdk/usages")
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 \"customerRef\": \"<string>\",\n \"metadata\": {},\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"actionType\": \"api_call\",\n \"description\": \"<string>\",\n \"duration\": 1,\n \"errorMessage\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"outcome\": \"success\",\n \"productRef\": \"<string>\",\n \"purchaseRef\": \"<string>\",\n \"units\": 1\n}"
response = http.request(request)
puts response.read_body{
"reference": "usage_A1B2C3D4",
"success": true
}Body
application/json
Minimum string length:
1Available options:
transaction, api_call, hour, email, storage, custom Required range:
x > 0Maximum string length:
256Available options:
success, paywall, fail Required range:
0 < x < 100000⌘I