Skip to main content
Open Data Protocol (OData) is a standard for building and using RESTful APIs. This protocol simplifies data access for web clients by providing a consistent way to describe data models and perform CRUD operations (create, read, update, delete) using standard HTTP methods and URLs. Based on the OData protocol version 4, Cognigy.AI offers an OData Analytics endpoint to retrieve raw data using GET requests. This endpoint meets all your enterprise analytics needs, enabling you to make fine-grained queries in your spreadsheets or build rich dashboards for AI Agents with your favorite data visualization tool. Watch this video to get a quick overview of what the OData Analytics endpoint is, how it works, and in which scenarios you can use it:
To analyze your AI Agent’s performance, you can use the built-in Insights reports as an alternative to OData or in addition to it.

Restrictions

  • The Cognigy.AI OData endpoint supports only the OData protocol version 4.
  • The Cognigy.AI OData endpoint only supports GET requests and doesn’t support any other request types, such as PATCH, DELETE, or POST.
  • The data retrieved through the Cognigy.AI OData endpoint isn’t updated in real time and may not reflect the current state.
  • The $skip query at high values, such as 10000, may impact performance and cause API timeouts. In these cases, use keyset pagination, for example, with the timestamp or _id field.

Supported Versions

Cognigy.AI versionCognigy.AI OData endpoint versionStatus
4.65 and later2.4Supported
4.48 and later2.3Supported; deprecation in December, 2025
4.31-4.472.0–2.3Not supported
4.30 and earlier2.0–2.2Not supported

Data Protection

You can control the data available through the OData endpoint at both the Endpoint and Flow levels:
  • Endpoint — go to the Data Protection & Analytics section in the Endpoint settings:
    • If you disable the Collect Analytics setting, no analytics data is logged or available in OData.
    • If you enable the Mask Sensitive Analytics setting, the inputText and inputData fields are masked.
  • Flow — add a Blind Mode Node to your Flow. This Node disables or masks analytics data available to the OData endpoint.

OData Endpoint Access

You can access the OData endpoint through a different domain than Cognigy.AI:
  • Trial — https://odata-trial.cognigy.ai.
  • Shared SaaS — https://odata-<your-domain>.cognigy.ai.
  • Dedicated SaaS — contact your Customer Success Manager or Cognigy.AI Support to get the OData endpoint URL.
  • On-premises — https://odata-<backend-url>, where <backend-url> refer to the URL assigned to the BACKEND_BASE_URL_WITH_PROTOCOL in values.yaml.

Authentication

To connect to the OData endpoint, you need to have the odata global role and an API Key. The OData endpoint URL format is as follows: https://<odata-domain>/<api-version>/<collection>?apikey=<your-api-key>, where
  • odata domain — the base domain of the OData service. It is the root URL where your OData service is hosted.
  • api-version — the version of the API you are interacting with. Currently, Cognigy.AI supports OData 2.4.
  • collection — a specific collection within the OData service you want to access.
  • your-api-key — an API key that provides authentication and authorization for accessing the API. You need to get this key from your profile.
OData endpoint URL example: https://odata-trial.cognigy.ai/v2.4/Analytics?apikey=123abc, where
  • odata-trial.cognigy.ai — the Cognigy.AI OData base domain.
  • v2.4 — the API version of the Cognigy.AI OData endpoint.
  • Analytics — the Analytics data collection you’re trying to access within Cognigy.AI.
  • 123abc — your unique API key.

Authentication for Microsoft Excel and Power BI

When using Microsoft Excel and Power BI, you might be prompted to authenticate. In this case, select Anonymous Authentication.

System Query Options

The OData endpoint supports the following OData system query options:
  • $filter
  • $skip
  • $top
  • $orderby
  • $select
  • $count1

Examples

The tables contain examples of requests using system query options. Select the OData endpoint version compatible with your Cognigy.AI version.
  • OData 2.4
  • OData 2.3
Request DescriptionOData 2.4 Request
Returns total count of Analytics records (not supported in Microsoft Excel or Power BI).https://odata-trial.cognigy.ai/v2.4/Analytics/$count?apikey=<your-api-key>
Returns all Analytics records for the given API Key.https://odata-trial.cognigy.ai/v2.4/Analytics?apikey=<your-api-key>
Returns the first 10 Analytics records.https://odata-trial.cognigy.ai/v2.4/Analytics/?$top=10&apikey=<your-api-key>
Returns the top 5 Analytics records where executionTime is less than 50ms, ordered by executionTime.https://odata-trial.cognigy.ai/v2.4/Analytics/?$filter=executionTime lt 50&$top=5&$orderby=executionTime&apikey=<your-api-key>
Returns all Analytics records for a specific Cognigy.AI Project filtered by projectIdhttps://odata-trial.cognigy.ai/v2.4/Analytics/?$filter=projectId eq '<project-id>'&apikey=<your-api-key>
Returns Project and session IDs for a specific Cognigy.AI project. The request filters the data based on the projectId field and selects only the projectId and sessionId for each matching entry.https://odata-trial.cognigy.ai/v2.4/Analytics/?$filter=projectId eq '<project-id>'&$select=projectId,sessionId&apikey=<your-api-key>
Returns all Analytics records between two dates, for example, 1st Jan 2021 and 1st July 2021.https://odata-trial.cognigy.ai/v2.4/Analytics/?$filter=timestamp gt '2021-01-01T00:00:00.000Z' and timestamp lt '2021-07-01T00:00:00.000Z'&apikey=<your-api-key>
For a full reference, refer to the extensive collection of resources at OData.org and the Oasis OData URL Convention documentation.

Cognigy.AI OData Collections

The OData endpoint provides access to several data collections containing information about your interactions and workflows. The set of collections varies depending on which version you are using:
  • Version 2.4
  • Version 2.3
The current version of the OData endpoint is v2.4. In this version, the following OData collections are available:The URL for accessing the OData endpoint 2.4 is as follows: https://<odata-domain>/v2.4/<collection>?apikey=<your-api-key>
Each collection can be filtered by its fields, which are often retrieved directly from the Input object results.

Collections

A collection is similar to a database table or a set of entities containing data.

Analytics

The Analytics collection offers a log of comprehensive details such as organizational information, Project identifiers, Flow specifics, and essential performance metrics. Each chat or voice AI Agent session in Cognigy.AI creates an Analytics record for an interaction. Each interaction is logged as a single record. The information is saved only after the end of the session. You can change this data using the Overwrite Analytics Node.

Requests

Select an API request to extract data from the collection. The API version in the request must match your Cognigy.AI version.
  • OData 2.4
  • OData 2.3
https://odata-trial.cognigy.ai/v2.4/Analytics?apikey=<your-api-key>
Response
With Cognigy.AI 4.91, the Understood Messages concept was deprecated, with removal from the Insights reports scheduled for version 2025.19. Use the Goals and Tasks concepts to evaluate whether your AI Agent understood a particular phrase.Respectively, the OData endpoint understood field was deprecated in the same version, with full removal scheduled for version 2025.24. Use the Goals collection in the Cognigy.AI OData endpoint.Refer to the list of all upcoming removals on the Deprecations and Removals page.
When retrieving this collection, the endpoint returns the following fields:
Field Name
Description
TypeExample
idThe unique ID of the record. Applicable to the OData endpoint 2.4 or later.String5a91d194fde28b0011ce2423
_idThe unique ID of the record. Applicable to the OData endpoint 2.3 or earlier.String5a91d194fde28b0011ce2423
organisationThe name of your organization.Stringcognigy
projectIdThe ID of the Project related to the record.String5a91d194fde28b0011ce2422
flowReferenceIdThe ID of the Flow.String66ceb9cc-ac5b-4cdd-9f4b-8a48dfbb35d9
entrypointThe ID of the Project or Snapshot used by the Endpoint.String621d3deb87016d3855ec0c92
ipThe IP address from which the request originated.String78.143.45.111
contactIdThe hash of the user ID.String99ea95befe61812656bf963ba7d44ab7
sessionIdThe session ID.String5a91d194fde28b0011ce2425
inputIdThe ID of the input message.String5a91d194fde28b0011ce2424
inputTextThe input text.StringHello World!
inputDataThe input data object as a string.String{"key":"value"}
stateThe state of the Flow at input.Stringdefault
modeThe mode of the input.StringTextOnly
userTypeThe type of the connecting user. Either external for external user or admin for admin user.Stringexternal
channelThe channel through which the record was received.Stringfacebook
flowLanguageThe language of the Flow.Stringen-EN
intentThe found Intent. This field can be empty.StringorderFood
intentFlowThe Parent ID of the Flow in which the Intent was found. This field can be empty.String5e33b160e6236da3aa54221461a53f04
intentScoreThe numerical score of the input against a recognized Intent. This field can be empty.Number0.836322430892043
completedGoalsListA list of completed goals in this session.StringorderedFood
foundSlotsFound Slot tags.StringDATE
foundSlotDetailsFound Slot tags with details.StringDATE[2018-2-25T12:32:32.000]
understoodAn input is considered understood if any of the following conditions are met:
- An Intent or Slot is identified.
- The input is marked as understood through the Nodes: Code, Overwrite Analytics, Search Extract Output, or AI Agent.
- The sentence type is pAnswer, nAnswer, or Greeting (if Confirmation Word logic is activated).

An input is considered not understood if any of the following conditions are met:
- There is an active handover without triggering an AI Copilot Whisper Flow.
- The message is explicitly marked as Don't count or Null.
Booleantrue
timestampThe date and time of the input.DateTime2018-2-25T12:32:32.000Z
executionTimeThe time it took to execute the Flow in milliseconds.Number32
executionThe Flow execution count.Number3
custom1The custom value created by the Flow. The custom field has a maximum character limit of 1024.Stringcustom value
custom2The custom value created by the Flow. The custom field has a maximum character limit of 1024.Stringcustom value
custom3The custom value created by the Flow. The custom field has a maximum character limit of 1024.Stringcustom value
custom4The custom value created by the Flow. The custom field has a maximum character limit of 1024.Stringcustom value
custom5The custom value created by the Flow. The custom field has a maximum character limit of 1024.Stringcustom value
custom6The custom value created by the Flow. The custom field has a maximum character limit of 1024.Stringcustom value
custom7The custom value created by the Flow. The custom field has a maximum character limit of 1024.Stringcustom value
custom8The custom value created by the Flow. The custom field has a maximum character limit of 1024.Stringcustom value
custom9The custom value created by the Flow. The custom field has a maximum character limit of 1024.Stringcustom value
custom10The custom value created by the Flow. The custom field has a maximum character limit of 1024.Stringcustom value
localeReferenceIdThe reference ID for the locale.String4bfdcf40-a605-4686-8e92-b17fa9f178af
localeNameThe name of the locale.StringEnglish
endpointUrlTokenThe URL token for the Endpoint.Stringea30b8f20db52f9d86ea36fd55a7d66bd2c4c60eb24ac7ad52f1c9e173dd4cdb
endpointNameThe name of the Endpoint.StringMyEndpoint
ratingThe rating for the session: -1 for a negative rating or 1 for a positive rating.Number1
ratingCommentThe comment left when given a rating.StringGreat service!
snapshotNameThe name for the Snapshot used by the Endpoint.StringBot Release 2.2
The Analytics step label can be updated from the Cognigy.AI UI at any time. Therefore, to ensure compatibility between past and future data records, the entityReferenceId field is used. This field corresponds to either the Node ID or Intent ID assigned as an Analytics step. The current Analytics step label can be retrieved by mapping the entityReferenceID field to the Steps record.

Conversations

The Conversations collection offers a log of all session messages, including messages from the end user, AI Agent, and human agent. Each time one of these sources sends a message to a Flow, Cognigy.AI creates a record to log the interaction. Each interaction is logged as a single record. Requests Select an API request to extract data from the collection. The API version in the request must match your Cognigy.AI version.
  • OData 2.4
  • OData 2.3
https://odata-trial.cognigy.ai/v2.4/Conversations?apikey=<your-api-key>
Response When retrieving this collection, the endpoint returns the following fields:
Field Name
Description
TypeExample
idThe unique ID of the record. Applicable to the OData endpoint 2.4 or later.String5a91d194fde28b0011ce2423
_idThe unique ID of the record. Applicable to the OData endpoint 2.3 or earlier.String5a91d194fde28b0011ce2423
projectIdThe ID of the Project related to the record.String5a91d194fde28b0011ce2422
projectNameThe name of the Project.StringProject 1
inputIdThe ID of the input message.String5a91d194fde28b0011ce2424
sessionIdThe session ID.String5a91d194fde28b0011ce2425
contactIdThe ID of the connecting user.StringmyContactID
organisationThe name of your organization.Stringcognigy
inputTextThe input text.StringHello World!
inputDataThe input data object as a string.String{"key":"value"}
typeWhether the message is an input or output of the Flow.String”input” or “output”
sourceThe source of the message.String”user” or “bot” or “agent” or “suggestion”
timestampThe date and time of the input.DateTime2018-2-25T12:32:32.000Z
flowNameThe name of the Flow.StringMainFlow
flowParentIdThe Parent ID of the Flow.String5e33b160e6236da3aa54221461a53f04
channelThe channel through which the record was received.Stringfacebook
inHandoverRequestA flag indicating whether the session is in a handover request.Booleanfalse
inHandoverConversationA flag indicating whether the session is in a handover session.Booleantrue
outputIdThe output ID.Stringf514b7b2-7dc0-4e75-be62-a53fed5b2bb7
inputAttachmentsThe list of attachments that the end user uploads to the chat. Each attachment will contain the URL of the file, file name, and file type.

When a human agent uploads a file, it will be recorded in the OData format as follows, without any specific information about the file: [{"*****":"*****"}].
Object{"url":"https://files-api-trial.cognigy.ai/v1.0/63babf6e92add771923e87b7/","name":"abandon-rate.png","type":"image"}
referenceThe Reference ID. For example, to reference a suggestion.Stringnull
localeReferenceIdThe ID of the locale.String7eff993c-b801-4556-b111-1c319e8577cf
endpointUrlTokenThe URL token for the Endpoint.Stringea30b8f20db52f9d86ea36fd55a7d66bd2c4c60eb24ac7ad52f1c9e173dd4cdb
endpointNameThe name of the Endpoint.StringMyEndpoint
snapshotIdThe ID of the Snapshot.String63ff0cc47a466cab278fd19b
snapshotNameThe name of the Snapshot.StringBot Release 2.2
ratingThe rating for the session: -1 for a negative rating or 1 for a positive rating.Number1
ratingCommentThe comment left when given a rating.StringGreat service!

Steps

The Steps collection provides a list of all entities, which are either Nodes or Intents, assigned as Analytics steps within any Flow. An Analytics step appear in this OData collection only after it has been triggered at least once in a session within the Flow. Each step is logged as a single record. Requests Select an API request to extract data from the collection. The API version in the request must match your Cognigy.AI version.
  • OData 2.4
  • OData 2.3
https://odata-trial.cognigy.ai/v2.4/Steps?apikey=<your-api-key>
Response When retrieving this collection, the endpoint returns the following fields:
Field Name
Description
TypeExample
idThe unique ID of the record. Applicable to the OData endpoint 2.4 or later.String5a91d194fde28b0011ce2423
_idThe unique ID of the record. Applicable to the OData endpoint 2.3 or earlier.String5a91d194fde28b0011ce2423
labelThe Analytics step label defined for the entity (Node or Intent) in Cognigy.AI.StringQuestion (2)
typeThe type of entity.Stringnode or intent
entityReferenceIdThe unique ID for the entity (Node ID or Flow ID).String5a91d194fde28b0011ce2423
flowReferenceIdThe ID of the Flow.String5a91d194fde28b0011ce2423
flowNameThe name of the Flow where the Analytics step is configured.StringMain Flow
projectNameThe name of the Project.StringProject 1
snapshotIdThe ID of the Snapshot.String5e33b160e6236da3aa54221461a53f04
snapshotNameThe name of the Snapshot.StringBot Release 2.2
The Step Monitoring with OData article explains how these records can be manipulated in BI software to build insightful session path analytics.

ExecutedSteps

The ExecutedSteps collection logs all step events in sessions, including a reference to the prior (parent) step. Whenever a Node or Intent with an assigned step is executed, the collection creates a record for that step. Each step is logged as a single record.
  • OData 2.4
  • OData 2.3
https://odata-trial.cognigy.ai/v2.4/ExecutedSteps?apikey=<your-api-key>
Response When retrieving this collection, the endpoint returns the following fields:
Field Name
Description
TypeExample
idThe unique ID of the record. Applicable to the OData endpoint 2.4 or later.String5a91d194fde28b0011ce2423
_idThe unique ID of the record. Applicable to the OData endpoint 2.3 or earlier.String5a91d194fde28b0011ce2423
userIdThe ID of the connecting user.StringmyContactID
sessionIdThe session ID.String5a91d194fde28b0011ce2425
inputIdThe ID of the input message.String5a91d194fde28b0011ce2425
stepLabelThe Analytics step label defined for the entity (Node or Intent)StringQuestion (2)
parentStepThe ID of the step that occurred prior to this step.String5a91d194fde28b0011ce2425
typeThe type of entity.Stringnode or intent
entityReferenceIdThe unique ID for the entity (Node ID or Intent ID).String5a91d194fde28b0011ce2423
flowReferenceIdThe ID of the Flow.String5a91d194fde28b0011ce2423
flowNameThe name of the Flow where the step exists.StringMain Flow
timestampThe date and time when the step was executed.DateTime2018-2-25T12:32:32.000Z
projectNameThe name of the Project.StringProject 1
projectIdThe ID of the Project related to the record.String6067352c18887e471da4e392
organisationIdThe ID of the organization associated with the record.String5f8833dae72b850ad2ed4d53
snapshotIdThe ID of the Snapshot.String5e33b160e6236da3aa54221461a53f04
snapshotNameThe name of the Snapshot.StringBot Release 2.2
localeReferenceIdThe ID of the locale.String7eff993c-b801-4556-b111-1c319e8577cf
localeNameThe name of the locale.StringEnglish
endpointUrlTokenThe URL token for the Endpoint.Stringea30b8f20db52f9d86ea36fd55a7d66bd2c4c60eb24ac7ad52f1c9e173dd4cdb
endpointNameThe name of the Endpoint.StringMyEndpoint

Sessions

The Sessions collection contains a list of all sessions that have occurred. The primary objective of this collection is to provide a list of the Analytics steps that took place in any given session, along with the order of execution. This information is included as a comma-separated list within a field called stepPath. Each session is logged as a single record.
  • OData 2.4
  • OData 2.3
https://odata-trial.cognigy.ai/v2.4/Sessions?apikey=<your-api-key>
Response When retrieving this collection, the endpoint returns the following fields:
Field Name
Description
TypeExample
idThe unique ID of the record. Applicable to the OData endpoint 2.4 or later.String5a91d194fde28b0011ce2423
_idThe unique ID of the record. Applicable to the OData endpoint 2.3 or earlier.String5a91d194fde28b0011ce2423
goalsAll the goals that were achieved in the session.StringGoal1, Goal2
stepPathA comma-separated list of executed steps.String9ac4f679-beae-4461-b9e3-43aece8b3430,f1e72fe3-f04b-48f5-b862-1e35ad253f18, …
stepsCountThe count of the number of steps.Number10
handoverEscalationsThe number of times the session triggered a handover.Number3
startedAtThe date and time when first message was received.DateTime2018-2-25T12:32:32.000Z
userIdThe ID of the connecting user.StringmyContactID
sessionIdThe session ID.String5a91d194fde28b0011ce2425
localeReferenceIdThe ID of the locale.String7eff993c-b801-4556-b111-1c319e8577cf
localeNameThe name of the locale.StringEnglish
endpointReferenceIdThe ID of the Endpoint.String5e33b160e6236da3aa54221461a53f04
endpointNameThe name of the Endpoint.StringWebchat
projectNameThe name of the Project.StringProject 1
projectIdThe ID of the Project related to the record.String6067352c18887e471da4e392
organisationIdThe ID of the organization associated with the record.String5f8833dae72b850ad2ed4d53
snapshotIdThe ID of the Snapshot.String5e33b160e6236da3aa54221461a53f04
snapshotNameThe name of the Snapshot.StringBot Release 2.2
endpointUrlTokenThe URL token for the Endpoint.Stringea30b8f20db52f9d86ea36fd55a7d66bd2c4c60eb24ac7ad52f1c9e173dd4cdb
ratingThe rating for the session: -1 for a negative rating or 1 for a positive rating.Number1
ratingCommentThe comment left when given a rating.StringGreat service!

LiveAgentEscalations

The LiveAgentEscalations collection contains records from Cognigy Live Agent and includes the related data about handovers to Live Agent. Each handover (escalation) is logged as a single record.
  • OData 2.4
  • OData 2.3
https://odata-trial.cognigy.ai/v2.4/LiveAgentEscalations?apikey=<your-api-key>
Response When retrieving this collection, the endpoint returns the following fields:
Field Name
Description
TypeExample
idThe unique ID of the record. Applicable to the OData endpoint 2.4 or later.String5a91d194fde28b0011ce2423
_idThe unique ID of the record. Applicable to the OData endpoint 2.3 or earlier.String5a91d194fde28b0011ce2423
organisationIdThe ID of the organization associated with the record.String5eb4a49d426cd3d05f2892a9
projectIdThe ID of the Project related to the record.String6409b6c53c9687b5e78e6403
sessionIdThe session ID.Stringsession-2a38246e-0395-49a5-876d-dd5133fd5418
timestampThe date and time when the record was created.DateTime2023-06-28T07:59:04.628Z
localeNameThe name of the locale.Stringen
statusThe current status of the escalated conversation in Live Agent. The possible statures are: opened, assigned, resolved, and abandoned.Stringopened
inboxIdThe ID of the inbox associated with the record.String7983
inboxNameThe name of the inbox.StringLA Chatbot-default
teamIdThe ID of the team assigned to the conversation.String8
teamNameThe name of the team assigned to the conversation.StringIT Support
labelsThe list of labels assigned to the conversation.Array[Hardware]
agentIdThe ID of the human agent assigned to the conversation.String618cf7687614774ba028dcac
agentNameThe name of the human agent assigned to the conversation. This field is supported from Cognigy.AI 4.80.StringJohn Doe
contactIdThe ID of the connecting user.String649ba8450d5df5cadf8b75b8
endpointNameThe name of the Endpoint.StringLA Chatbot
endpointTypeThe type of the Endpoint.Stringwebchat2
endpointUrlTokenThe URL token for the Endpoint.Stringea30b8f20db52f9d86ea36fd55a7d66bd2c4c60eb24ac7ad52f1c9e173dd4cdb
channelThe channel through which the record was received.Stringadmin-webchat
localeReferenceIdThe ID of the locale.String7eff993c-b801-4556-b111-1c319e8577cf
snapshotIdThe ID of the Snapshot.String63ff0cc47a466cab278fd19b
snapshotNameThe name of the Snapshot.StringProd-Snapshot 26.7.23

Goals

The Goals collection contains records from goals. Each goal is logged as a single record.
  • OData 2.4
https://odata-trial.cognigy.ai/v2.4/Goals?apikey=<your-api-key>
Response When retrieving this collection, the endpoint returns the following fields:
Field Name
Description
Field TypeExample
goalIdThe goal ID.String66ebf71693dfb26c3ca4c827
nameThe name of the goal.StringGoal_07
versionThe UUID for tracking the current version of the goal configuration. Each update or change of the goal configuration creates a new version.String8ec4de84-71e2-4c98-a7c3-b18173f36223
descriptionThe description of the goal.StringThe goal is to gather metrics for a flight booking use case.
referenceIdThe Reference ID associated with the goal.String04dd272f-6c8c-4957-9714-937e6f0847c2
projectIdThe ID of the Project related to the record.String5a91d194fde28b0011ce2422
organisationIdThe ID of the organization associated with the record.String5eb4a49d426cd3d05f2892a9
createdAtTimestamp indicating when the goal was created.Timestamp2024-09-19T10:04:06.000Z
lastChangedTimestamp of the last update to the goal.Timestamp2024-09-19T10:04:06.000Z
createdByThe identifier for the user who created the goal.String63bff78cd74f7c7f7dd12944
lastChangedByThe identifier for the user who last modified the goal.String63bff78cd74f7c7f7dd12944

GoalSteps

The GoalSteps collection contains records about a specific Goal step from goals. Each goal is logged as a single record.
  • OData 2.4
https://odata-trial.cognigy.ai/v2.4/GoalSteps?apikey=<your-api-key>
Response When retrieving this collection, the endpoint returns the following fields:
Field Name
Description
Field TypeExample
goalStepIdThe goal step ID.String66eac7950dc3fd6e4b3bcd8c
nameThe name of the goal step.StringStart
versionThe UUID for tracking step the version of the specific step configuration within the goal. Each update or change of the goal configuration creates a new version.String6cb467d0-9f79-4df0-ad31-991d1bb91910
descriptionThe description of the goal step.StringThe goal is to gather metrics for a flight booking use case.
orderThe order of the step within the goal configuration.Integernull
textAdditional text information for the goal stepStringnull
typeThe type of the goal step:
start — the initial (first) step of the goal. It shows the beginning of the process.
completion — the completion (last) step of the goal. It shows that the objectives are met.
Stringstart
goalIdThe goal ID for the goal associated with the step.String66eac7950dc3fdb39c3bcd8b
projectIdThe ID of the Project related to the record.String5a91d194fde28b0011ce2422
organisationIdThe ID of the organization associated with the record.String5eb4a49d426cd3d05f2892a9

GoalStepMetrics

The GoalStepMetrics collection contains records about specific goal-related events from goals. Each metric is logged as a single record.
  • OData 2.4
https://odata-trial.cognigy.ai/v2.4/GoalStepMetrics?apikey=<your-api-key>
Response When retrieving this collection, the endpoint returns the following fields:
Field Name
Description
Field TypeExample
goalStepMetricIdThe metric ID for the goal step.String66ebf5a2cabacf6ecb0b5a81
nameThe name of the metric.Stringnull
versionThe UUID for tracking step the version of the specific metric configuration within the goal. Each update or change of the goal configuration creates a new version.String6cb467d0-9f79-4df0-ad31-991d1bb91910
descriptionThe description of the metric.Stringnull
typeThe category of metrics that can be tracked for goals:
- duration — time in minutes or hours.
- currency — currency specified in the Project settings.
Stringcurrency
valueThe value of the metric.Integer20
goalIdThe goal ID.String66ebf5a2cabacf2ac70b5a7e
goalStepIdThe goal step ID.String66ebf5a2cabacf7c810b5a80
projectIdThe ID of the Project related to the record.String5a91d194fde28b0011ce2422
organisationIdThe ID of the organization associated with the record.String5eb4a49d426cd3d05f2892a9

GoalEvents

The GoalEvents collection contains records about specific goal-related events from goals. Each event is logged as a single record.
  • OData 2.4
https://odata-trial.cognigy.ai/v2.4/GoalEvents?apikey=<your-api-key>
Response When retrieving this collection, the endpoint returns the following fields:
Field Name
Description
Field TypeExample
idThe unique ID of the record. Applicable to the OData endpoint 2.4 or later.String5a91d194fde28b0011ce2423
versionThe UUID for tracking the current version of the goal configuration. Each update or change of the goal configuration creates a new version.String8ec4de84-71e2-4c98-a7c3-b18173f36223
timestampThe date and time indicating when a specific event related to the goal occurred.Timestamp2024-09-19T10:00:02.322Z
goalCycleIdThe ID of the goal cycle to track each iteration of a goal. The cycle groups different goal tracking events into one attempt to complete a goal.Stringa0da54a5-ee2e-43be-b743-23d4bccf513c
stepIdThe ID of the specific goal step.String66ebeca3cabacf41170b4a6d
goalIdThe goal ID.String66ebeca3cabacf6c820b4a6c
sessionIdThe session ID.Stringsession-2a38246e-0395-49a5-876d-dd5133fd5418
projectIdThe ID of the Project related to the record.String5a91d194fde28b0011ce2422
organisationIdThe ID of the organization associated with the record.String5eb4a49d426cd3d05f2892a9
expiresAtThe expiration date for the goal record. After that time, the goal record will be removed from the Analytics database.Timestampnull
localeNameThe name of the locale.StringEnglish
endpointNameThe name of the Endpoint.StringLA Chatbot
endpointTypeThe type of the Endpoint.Stringwebchat2
endpointUrlTokenThe URL token for the Endpoint.Stringea30b8f20db52f9d86ea36fd55a7d66bd2c4c60eb24ac7ad52f1c9e173dd4cdb
channelThe channel through which the record was received.Stringadmin-webchat
localeReferenceIdThe ID of the locale.String7eff993c-b801-4556-b111-1c319e8577cf
snapshotIdThe ID of the Snapshot.String63ff0cc47a466cab278fd19b
snapshotNameThe name for the Snapshot used by the Endpoint.StringBot Release 2.2

Cognigy.AI OData Collections: Entity Relationship Diagram (ERD)

The Entity Relationship Diagram (ERD) describes the relationships between the collection entities.

Integrations

The Cognigy.AI OData endpoint can integrate with all tools compatible with the OData protocol version 4. The table outlines popular integration tools, including data visualization tools, recommended for integration.
ToolDescription
Microsoft ExcelMicrosoft Excel is a spreadsheet application widely used for data analysis and reporting. When connecting from Microsoft Excel 2016, use the PowerQuery feature, which can be found under Data > Get & Transform > New Query > From Other Sources > From OData Feed.
Microsoft Power BIMicrosoft Power BI is a business analytics service that provides interactive visualizations and business intelligence capabilities. For for integrating with the Cognigy.AI OData endpoint, refer to the Microsoft Power BI documentation.
OData Consumer EcosystemThe OData Consumer Ecosystem encompasses a variety of tools and applications that support the consumption of OData services. For a full list of available OData Consumer options, refer to the OData documentation.
Client Libraries in .NET, Java, JavaScript, C++ and other platformsClient libraries are available in multiple programming languages and platforms, providing developers with OData protocol implementations. For a full list of available libraries, refer to the OData documentation.
If you want to use another tool not listed in the table, verify its compatibility with the OData endpoint on the OData website and in the tool’s documentation before integrating. For example, the data visualization tool Tableau can’t be used for integration because it doesn’t support the OData protocol version 4 on which the OData endpoint is based.

Keyset Pagination

Keyset pagination is a more efficient way to retrieve data from large datasets where you need to set $skip to high values, such as 10000. To use keyset pagination, follow these steps:
  1. Retrieve the first page with the $top and $orderby query options, for example, https://odata-trial.cognigy.ai/v2.4/Conversations?apikey=<your-api-key>&$top=10000&$orderby=timestamp asc.
  2. Use the last timestamp value from the previous page in the next page request, for example, https://odata-trial.cognigy.ai/v2.4/Conversations?apikey=<your-api-key>&$filter=timestamp gt <LAST_TIMESTAMP_FROM_PREVIOUS_PAGE>&$top=10000&$orderby=timestamp asc.
  3. Repeat step 2 until you have retrieved all the records.

More Information


1: Microsoft Excel and Power BI do not support for the $count query. Use Postman or other options. To perform this query, consider using tools such as Postman or other applications that support advanced API querying.
I