Get Usage By Dataset ID

Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.

GET /api/dataset/usage/{dataset_id}

Get Usage By Dataset ID

cURL

curl --request GET \
  --url https://api.trieve.ai/api/dataset/usage/{dataset_id} \
  --header 'Authorization: <api-key>' \
  --header 'TR-Dataset: <tr-dataset>'

import requests

url = "https://api.trieve.ai/api/dataset/usage/{dataset_id}"

headers = {
    "TR-Dataset": "<tr-dataset>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'TR-Dataset': '<tr-dataset>', Authorization: '<api-key>'}
};

fetch('https://api.trieve.ai/api/dataset/usage/{dataset_id}', 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.trieve.ai/api/dataset/usage/{dataset_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "TR-Dataset: <tr-dataset>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.trieve.ai/api/dataset/usage/{dataset_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("TR-Dataset", "<tr-dataset>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.trieve.ai/api/dataset/usage/{dataset_id}")
  .header("TR-Dataset", "<tr-dataset>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trieve.ai/api/dataset/usage/{dataset_id}")

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

request = Net::HTTP::Get.new(url)
request["TR-Dataset"] = '<tr-dataset>'
request["Authorization"] = '<api-key>'

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

200

{
  "chunk_count": 100,
  "dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
  "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3"
}

{
  "message": "Bad Request"
}

{
  "message": "Bad Request"
}

Authorizations

Authorization · string · header · required

Headers

TR-Dataset · string<uuid> · required

The dataset id or tracking_id to use for the request. We assume you intend to use an id if the value is a valid uuid.

Path Parameters

dataset_id · string<uuid> · required

The id of the dataset you want to retrieve usage for.

Response

200

application/json

Dataset usage retrieved successfully

chunk_count · integer<int32> · required

dataset_id · string<uuid> · required

id · string<uuid> · required