# Observe.AI Interactions API **Canonical:** https://apis.io/apis/observeai/observeai-interactions-api/ **Provider:** Observe.AI — https://apis.io/providers/observeai/ **Base URL:** https://kong.observe.ai/ **Documentation:** https://api-docs.observe.ai/ Observe.AI Interactions API is one of 7 APIs that [Observe.AI](https://apis.io/providers/observeai/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 16 JSON Schema definitions. Tagged areas include Interactions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, rate-limit docs, and 16 JSON Schemas. Interactions API is an omnichannel API can be used to obtain all the data related to the interactions like Moments, Transcripts and metadata related to Interactions(including Voice calls and Web chat). Please note -
  1. Allow 24 hrs to pass before pulling Interactions. ie., For Interactions completed on 14-Jan by 12:00AM PST, they would be available via APIs by 15-Jan by 12:00AM PST.
  2. You can pull Interactions for 30 days at a time i.e., the duration between the end_date and the start_date should not exceed 30 days.
  3. There is no limit as to how far back in the past you want to go for pulling Interactions. You can go back to the first ever evaluation on the platform unless data retention limits have been set.
  4. Interactions API gives a paginated response so the customer need to specify the page number and the desired amount of interactions in a page. By default, page_size is set to 100
  5. There is flexibility to either include or exclude Transcript in the API response by setting a query parameter includeTranscript. By default it is set to false.
  6. The S3 URL obtained in the API response (with the interactions) is valid for 24 hours.
  7. Clients using ‘Calls report API’ are requested to switch to ‘Interactions API’ which provides several benefits listed here. ‘Calls report API’ will be deprecated after 31-Dec-2022. Please reach out to your CSM for more details.
  8. If you have been using Basic Auth for the APIs, we request you to switch to OAuth2.0 based Auth for the APIs by 31-Dec-2022. Detailed instructions to create API Credentials and make the switch to OAuth are documented here. Please reach out to your CSM for more details.
  9. If you need to pull Interactions by ID, there is a separate synchronous API - Get Interactions By Ids.
## Machine-readable artifacts (26) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/openapi/observeai-interactions-api-openapi.yml - **Documentation** — https://api-docs.observe.ai/ - **APIReference** — https://api-docs.observe.ai/ - **GettingStarted** — https://api-docs.observe.ai/#tag/ReportingService-Overview - **Authentication** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/authentication/observeai-authentication.yml - **Conventions** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/conventions/observeai-conventions.yml - **RateLimits** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/rate-limits/observeai-rate-limits.yml - **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/errors/observeai-problem-types.yml - **DataModel** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/data-model/observeai-data-model.yml - **ChangeLog** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/changelog/observeai-changelog.yml - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-interaction-v1.schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-autoqa-evaluation-v1.schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-manual-evaluation-v1.schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-coaching-v1.schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-interaction-summary-v1.schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-agent-performance-assignment-v1.schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-audit-assignment-v1.schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-autoqa-ack-dispute-v1.schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-calibration-assignment-v1.schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-contact-reason-v1.schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-evaluation-template-v1.schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-manual-ack-dispute-v1.schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-sentiment-metric-v1.schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-team-v1.schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-user-login-activity-v1.schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/observeai/refs/heads/main/json-schema/observeai-bulk-export-user-v1.schema.json ## Other Observe.AI APIs (6) - [Observe.AI Ack Dispute Flow API](https://apis.io/apis/observeai/observeai-ack-dispute-flow-api/) - [Observe.AI Authentication API](https://apis.io/apis/observeai/observeai-authentication-api/) - [Observe.AI Coachings API](https://apis.io/apis/observeai/observeai-coachings-api/) - [Observe.AI DSR API](https://apis.io/apis/observeai/observeai-dsr-api/) - [Observe.AI Evaluations API](https://apis.io/apis/observeai/observeai-evaluations-api/) - [Observe.AI Summary API](https://apis.io/apis/observeai/observeai-summary-api/) ## Tags Interactions --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/observeai/observeai-interactions-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/observeai/.