Get metadata overview
Returns all available record types and supported query parameters for session analysis.
GET
/
session_analysis
/
metadata
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const metadata = await client.sessionAnalysis.metadata.retrieve();
console.log(metadata.meta);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
metadata = client.session_analysis.metadata.retrieve()
print(metadata.meta)package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
metadata, err := client.SessionAnalysis.Metadata.Get(context.TODO())
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", metadata.Meta)
}package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.sessionanalysis.metadata.MetadataRetrieveParams;
import com.telnyx.sdk.models.sessionanalysis.metadata.MetadataRetrieveResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
MetadataRetrieveResponse metadata = client.sessionAnalysis().metadata().retrieve();
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
metadata = telnyx.session_analysis.metadata.retrieve
puts(metadata)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$metadata = $client->sessionAnalysis->metadata->retrieve();
var_dump($metadata);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx session-analysis:metadata retrieve \
--api-key 'My API Key'curl --request GET \
--url https://api.telnyx.com/v2/session_analysis/metadata \
--header 'Authorization: Bearer <token>'{
"record_types": [
{
"record_type": "<string>",
"aliases": [
"<string>"
],
"product": "<string>",
"event": "<string>",
"description": "<string>",
"child_relationships": [
{
"relationship_type": "<string>",
"via": {
"local_field": "<string>",
"parent_field": "<string>"
},
"cost_rollup": true,
"traversal_enabled": true,
"description": "<string>",
"child_product": "<string>",
"child_event": "<string>",
"child_record_type": "<string>"
}
],
"parent_relationships": [
{
"relationship_type": "<string>",
"via": {
"local_field": "<string>",
"parent_field": "<string>"
},
"cost_rollup": true,
"traversal_enabled": true,
"description": "<string>",
"parent_product": "<string>",
"parent_event": "<string>",
"parent_record_type": "<string>"
}
]
}
],
"query_parameters": {},
"meta": {
"total_record_types": 123,
"last_updated": "2023-11-07T05:31:56Z"
}
}{
"errors": [
{
"code": "<string>",
"message": "<string>",
"detail": "<string>"
}
]
}{
"errors": [
{
"code": "<string>",
"message": "<string>",
"detail": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Was this page helpful?
⌘I
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const metadata = await client.sessionAnalysis.metadata.retrieve();
console.log(metadata.meta);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
metadata = client.session_analysis.metadata.retrieve()
print(metadata.meta)package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
metadata, err := client.SessionAnalysis.Metadata.Get(context.TODO())
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", metadata.Meta)
}package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.sessionanalysis.metadata.MetadataRetrieveParams;
import com.telnyx.sdk.models.sessionanalysis.metadata.MetadataRetrieveResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
MetadataRetrieveResponse metadata = client.sessionAnalysis().metadata().retrieve();
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
metadata = telnyx.session_analysis.metadata.retrieve
puts(metadata)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$metadata = $client->sessionAnalysis->metadata->retrieve();
var_dump($metadata);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx session-analysis:metadata retrieve \
--api-key 'My API Key'curl --request GET \
--url https://api.telnyx.com/v2/session_analysis/metadata \
--header 'Authorization: Bearer <token>'{
"record_types": [
{
"record_type": "<string>",
"aliases": [
"<string>"
],
"product": "<string>",
"event": "<string>",
"description": "<string>",
"child_relationships": [
{
"relationship_type": "<string>",
"via": {
"local_field": "<string>",
"parent_field": "<string>"
},
"cost_rollup": true,
"traversal_enabled": true,
"description": "<string>",
"child_product": "<string>",
"child_event": "<string>",
"child_record_type": "<string>"
}
],
"parent_relationships": [
{
"relationship_type": "<string>",
"via": {
"local_field": "<string>",
"parent_field": "<string>"
},
"cost_rollup": true,
"traversal_enabled": true,
"description": "<string>",
"parent_product": "<string>",
"parent_event": "<string>",
"parent_record_type": "<string>"
}
]
}
],
"query_parameters": {},
"meta": {
"total_record_types": 123,
"last_updated": "2023-11-07T05:31:56Z"
}
}{
"errors": [
{
"code": "<string>",
"message": "<string>",
"detail": "<string>"
}
]
}{
"errors": [
{
"code": "<string>",
"message": "<string>",
"detail": "<string>"
}
]
}