TypeScript (SDK)

import { Textql } from "@textql/sdk";

const textql = new Textql({
  apiKey: process.env["TEXTQL_API_KEY"] ?? "",
});

async function run() {
  const result = await textql.ontology.getUsageDetailsForFile({
    body: {},
  });

  console.log(result);
}

run();

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.ontology.get_usage_details_for_file()

    # Handle response
    print(res)

curl --request POST \
  --url https://app.textql.com/rpc/public/textql.rpc.public.patches.OntologyManagementService/GetUsageDetailsForFile \
  --header 'Connect-Protocol-Version: <connect-protocol-version>' \
  --header 'Content-Type: application/json' \
  --header 'tql_api_key: <api-key>' \
  --data '
{
  "filePath": "<string>",
  "observationPeriod": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {
    'Connect-Protocol-Version': '<connect-protocol-version>',
    tql_api_key: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({filePath: '<string>', observationPeriod: '<string>'})
};

fetch('https://app.textql.com/rpc/public/textql.rpc.public.patches.OntologyManagementService/GetUsageDetailsForFile', 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://app.textql.com/rpc/public/textql.rpc.public.patches.OntologyManagementService/GetUsageDetailsForFile",
  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([
    'filePath' => '<string>',
    'observationPeriod' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Connect-Protocol-Version: <connect-protocol-version>",
    "Content-Type: application/json",
    "tql_api_key: <api-key>"
  ],
]);

$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://app.textql.com/rpc/public/textql.rpc.public.patches.OntologyManagementService/GetUsageDetailsForFile"

	payload := strings.NewReader("{\n  \"filePath\": \"<string>\",\n  \"observationPeriod\": \"<string>\"\n}")

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

	req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
	req.Header.Add("tql_api_key", "<api-key>")
	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://app.textql.com/rpc/public/textql.rpc.public.patches.OntologyManagementService/GetUsageDetailsForFile")
  .header("Connect-Protocol-Version", "<connect-protocol-version>")
  .header("tql_api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filePath\": \"<string>\",\n  \"observationPeriod\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.textql.com/rpc/public/textql.rpc.public.patches.OntologyManagementService/GetUsageDetailsForFile")

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

request = Net::HTTP::Post.new(url)
request["Connect-Protocol-Version"] = '<connect-protocol-version>'
request["tql_api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filePath\": \"<string>\",\n  \"observationPeriod\": \"<string>\"\n}"

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

{
  "lastUsed": "2023-11-07T05:31:56Z",
  "days": [
    {
      "date": {
        "year": 123,
        "month": 123,
        "day": 123
      },
      "averageTokens": 123,
      "averageQueryTime": "<string>",
      "hitRate": 123,
      "numErrors": 123,
      "numEmpties": 123,
      "chatsPulled": 123,
      "chatsUsed": 123
    }
  ]
}

{
  "message": "<string>",
  "details": [
    {
      "type": "<string>",
      "value": "<string>",
      "debug": {}
    }
  ]
}

POST

textql.rpc.public.patches.OntologyManagementService

GetUsageDetailsForFile

TypeScript (SDK)

import { Textql } from "@textql/sdk";

const textql = new Textql({
  apiKey: process.env["TEXTQL_API_KEY"] ?? "",
});

async function run() {
  const result = await textql.ontology.getUsageDetailsForFile({
    body: {},
  });

  console.log(result);
}

run();

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.ontology.get_usage_details_for_file()

    # Handle response
    print(res)

curl --request POST \
  --url https://app.textql.com/rpc/public/textql.rpc.public.patches.OntologyManagementService/GetUsageDetailsForFile \
  --header 'Connect-Protocol-Version: <connect-protocol-version>' \
  --header 'Content-Type: application/json' \
  --header 'tql_api_key: <api-key>' \
  --data '
{
  "filePath": "<string>",
  "observationPeriod": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {
    'Connect-Protocol-Version': '<connect-protocol-version>',
    tql_api_key: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({filePath: '<string>', observationPeriod: '<string>'})
};

fetch('https://app.textql.com/rpc/public/textql.rpc.public.patches.OntologyManagementService/GetUsageDetailsForFile', 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://app.textql.com/rpc/public/textql.rpc.public.patches.OntologyManagementService/GetUsageDetailsForFile",
  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([
    'filePath' => '<string>',
    'observationPeriod' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Connect-Protocol-Version: <connect-protocol-version>",
    "Content-Type: application/json",
    "tql_api_key: <api-key>"
  ],
]);

$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://app.textql.com/rpc/public/textql.rpc.public.patches.OntologyManagementService/GetUsageDetailsForFile"

	payload := strings.NewReader("{\n  \"filePath\": \"<string>\",\n  \"observationPeriod\": \"<string>\"\n}")

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

	req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
	req.Header.Add("tql_api_key", "<api-key>")
	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://app.textql.com/rpc/public/textql.rpc.public.patches.OntologyManagementService/GetUsageDetailsForFile")
  .header("Connect-Protocol-Version", "<connect-protocol-version>")
  .header("tql_api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filePath\": \"<string>\",\n  \"observationPeriod\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.textql.com/rpc/public/textql.rpc.public.patches.OntologyManagementService/GetUsageDetailsForFile")

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

request = Net::HTTP::Post.new(url)
request["Connect-Protocol-Version"] = '<connect-protocol-version>'
request["tql_api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filePath\": \"<string>\",\n  \"observationPeriod\": \"<string>\"\n}"

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

{
  "lastUsed": "2023-11-07T05:31:56Z",
  "days": [
    {
      "date": {
        "year": 123,
        "month": 123,
        "day": 123
      },
      "averageTokens": 123,
      "averageQueryTime": "<string>",
      "hitRate": 123,
      "numErrors": 123,
      "numEmpties": 123,
      "chatsPulled": 123,
      "chatsUsed": 123
    }
  ]
}

{
  "message": "<string>",
  "details": [
    {
      "type": "<string>",
      "value": "<string>",
      "debug": {}
    }
  ]
}

Authorizations

tql_api_key

string

header

required

Headers

Connect-Protocol-Version

enum<number>

default:1

required

Define the version of the Connect protocol

Available options:

1

Connect-Timeout-Ms

number

Define the timeout, in ms

Body

application/json

filePath

string

observationPeriod

string<duration> | null

A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years.

Examples

Example 1: Compute Duration from two Timestamps in pseudo code.

Timestamp start = ...;
 Timestamp end = ...;
 Duration duration = ...;

 duration.seconds = end.seconds - start.seconds;
 duration.nanos = end.nanos - start.nanos;

 if (duration.seconds < 0 && duration.nanos > 0) {
   duration.seconds += 1;
   duration.nanos -= 1000000000;
 } else if (duration.seconds > 0 && duration.nanos < 0) {
   duration.seconds -= 1;
   duration.nanos += 1000000000;
 }

Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.

Timestamp start = ...;
 Duration duration = ...;
 Timestamp end = ...;

 end.seconds = start.seconds + duration.seconds;
 end.nanos = start.nanos + duration.nanos;

 if (end.nanos < 0) {
   end.seconds -= 1;
   end.nanos += 1000000000;
 } else if (end.nanos >= 1000000000) {
   end.seconds += 1;
   end.nanos -= 1000000000;
 }

Example 3: Compute Duration from datetime.timedelta in Python.

td = datetime.timedelta(days=3, minutes=10)
 duration = Duration()
 duration.FromTimedelta(td)

JSON Mapping

In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".

Response

Success

lastUsed

string<date-time>

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Timestamp timestamp;
 timestamp.set_seconds(time(NULL));
 timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

struct timeval tv;
 gettimeofday(&tv, NULL);

 Timestamp timestamp;
 timestamp.set_seconds(tv.tv_sec);
 timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

FILETIME ft;
 GetSystemTimeAsFileTime(&ft);
 UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

 // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
 // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
 Timestamp timestamp;
 timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
 timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

long millis = System.currentTimeMillis();

 Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
     .setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from Java Instant.now().

Instant now = Instant.now();

 Timestamp timestamp =
     Timestamp.newBuilder().setSeconds(now.getEpochSecond())
         .setNanos(now.getNano()).build();

Example 6: Compute Timestamp from current time in Python.

timestamp = Timestamp()
 timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

Examples:

"2023-01-15T01:30:15.01Z"

"2024-12-25T12:00:00Z"

days

DailyFileUsage · object[]

Show child attributes

SDK

Agent Service

App Service

Audit Log Service

Chat Service

Connector Service

Dashboard Service

Dataset Service

MCP Service

Metrics Export Service

Observability Service

Ontology Management Service

Playbook Service

Power BI Service

RBAC Service

Sandbox Admin Service

Sandbox Capability Service

Sandbox Exec Service

Sandbox Query Service

Scim Service

Secret Service

Settings Service

Slack Service

Tableau Service

Teams Service

Get Usage Details For File

Authorizations

Headers

Body

Examples

JSON Mapping

Response

Examples

JSON Mapping