Skip to main content
GET
/
session_analysis
/
metadata
/
{record_type}
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.sessionAnalysis.metadata.retrieveRecordType('record_type');

console.log(response.aliases);
{
  "record_type": "<string>",
  "aliases": [
    "<string>"
  ],
  "product": "<string>",
  "event": "<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>"
    }
  ],
  "examples": {},
  "meta": {
    "total_children": 123,
    "total_siblings": 123,
    "total_parents": 123,
    "max_recommended_depth": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
record_type
string
required

The record type identifier (e.g. "call-control").

Response

Record type metadata

​
record_type
string
required
​
aliases
string[]
required
​
product
string
required
​
event
string
required
​
child_relationships
object[]
required
​
parent_relationships
object[]
required
​
examples
object
required

Example queries and responses for this record type.

​
meta
object
required