### Summarization AI API - Base URL Example

Source: https://api-docs.observe.ai/index

This example shows the base URL structure for accessing the Summarization AI API. The `{base_url}` placeholder should be replaced with the specific cluster's base URL to make requests.

```http
https://{base_url}/v2/data/reports/interactions
```

--------------------------------

### Get Evaluations Report Sample

Source: https://api-docs.observe.ai/index

This is a sample JSON response for retrieving evaluation data. It includes start date, end date, status, and a URL for the report.

```json
{"start_date":"2022-03-03T00:00:12.000+00:00","end_date":"2022-04-04T00:14:00.000+00:00","status":"COMPLETED","url":"https://e2e-data-out.s3.amazonaws.com/reports/interactions/3058bc09-6d4d-4f22-9f69-6992f3520e56.json?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220510T045319Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAJUMHAEOBEW4GINBA%2F20220510%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=c87f8c8829f8127d3485fa79a8be56c33a0ce121238c579349c867f555940c10"}
```

--------------------------------

### Get Coaching Reports API Request

Source: https://api-docs.observe.ai/index

This snippet shows a sample JSON request body for retrieving coaching reports. It includes start and end dates, status, and a URL for the report.

```json
{
  "start_date": "2022-03-03T00:00:12.000+00:00",
  "end_date": "2022-04-04T00:14:00.000+00:00",
  "status": "COMPLETED",
  "url": "https://e2e-data-out.s3.amazonaws.com/reports/interactions/3058bc09-6d4d-4f22-9f69-6992f3520e56.json?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220510T045319Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAJUMHAEOBEW4GINBA%2F20220510%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=c87f8c8829f8127d3485fa79a8be56c33a0ce121238c579349c867f555940c10"
}
```

--------------------------------

### Create Coaching Request Response Sample

Source: https://api-docs.observe.ai/index

This is a sample JSON response for creating a coaching request. It includes request ID, start date, end date, and status.

```json
{"request_id":"3058bc09-f9fc-4586-bc7c-498b95a63ec2","start_date":"2022-03-03T00:00:12.000+00:00","end_date":"2022-04-04T00:16:00.000+00:00","status":"INPROGRESS"}
```

--------------------------------

### Create Coaching Request Payload

Source: https://api-docs.observe.ai/index

This JSON payload is used to create a coaching request. It requires start date, end date, and format.

```json
{
  "start_date": "2022-03-03T00:00:12.000+00:00", 
  "end_date": "2022-04-04T00:14:00.000+00:00", 
  "format": "JSON" 
}
```

--------------------------------

### Summarization AI API - Create Summaries Response Sample

Source: https://api-docs.observe.ai/index

This is a sample response from the Summarization AI API when creating summaries. It includes a request ID, the specified start and end dates, and the current status of the summary generation process.

```json
{"request_id":"3058bc09-f9fc-4586-bc7c-498b95a63ec2",
"start_date":"2022-03-03T00:00:12.000+00:00","end_date":"2022-04-04T00:16:00.000+00:00","status":"INPROGRESS"}
```

--------------------------------

### API Response Samples

Source: https://api-docs.observe.ai/index

Provides sample HTTP status codes and a JSON response payload for API requests. The JSON includes details about a data report, such as start and end dates, status, and a pre-signed S3 URL.

```json
{
  "start_date": "2022-03-03T00:00:12.000+00:00",
  "end_date": "2022-04-04T00:14:00.000+00:00",
  "status": "COMPLETED",
  "url": "https://e2e-data-out.s3.amazonaws.com/reports/interactions/3058bc09-6d4d-4f22-9f69-6992f3520e56.json?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220510T045319Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAJUMHAEOBEW4GINBA%2F20220510%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=c87f8c8829f8127d3485fa79a8be56c33a0ce121238c579349c867f555940c10"
}
```

--------------------------------

### API Endpoint for Interaction Reports

Source: https://api-docs.observe.ai/index

This snippet shows the GET request URL for fetching interaction reports from the Observe.AI API. It includes a placeholder for the base URL and the request ID.

```http
GET https://{base_url}/v1/data/reports/interactions/{request_id}
```

--------------------------------

### Get Coachings Request Status

Source: https://api-docs.observe.ai/index

This snippet shows how to check the status of a coaching data request. Upon completion, the response will contain details about coaching sessions and their mapped evaluations.

```bash
GET /v1/coachings/{requestId}
Host: YOUR_INSTANCE.observe.ai
Authorization: Bearer YOUR_AUTH_TOKEN
```

--------------------------------

### Get Summaries Request Status

Source: https://api-docs.observe.ai/index

This snippet shows how to check the status of a request for AI summaries. Upon completion, the response will contain the generated summaries or a link to them.

```bash
GET /v1/summaries/{requestId}
Host: YOUR_INSTANCE.observe.ai
Authorization: Bearer YOUR_AUTH_TOKEN
```

--------------------------------

### Get Ack Dispute Details - Response Sample (200 OK)

Source: https://api-docs.observe.ai/index

This is a sample JSON response for a successful request (HTTP 200 OK) to retrieve acknowledgement dispute details. It includes a pre-signed S3 URL for accessing report data.

```json
{
  "start_date": "2022-03-03T00:00:12.000+00:00",
  "end_date": "2022-04-04T00:14:00.000+00:00",
  "status": "COMPLETED",
  "url": "https://e2e-data-out.s3.amazonaws.com/reports/ackdispute/3058bc09-6d4d-4f22-9f69-6992f3520e56.json?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220510T045319Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAJUMHAEOBEW4GINBA%2F20220510%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=c87f8c8829f8127d3485fa79a8be56c33a0ce121238c579349c867f555940c10"
}
```

--------------------------------

### Post Evaluation Report Data

Source: https://api-docs.observe.ai/index

Submits evaluation data, including start and end dates and format, to generate a report. The response indicates the processing status.

```json
{
  "start_date": "2022-03-03T00:00:12.000+00:00",
  "end_date": "2022-04-04T00:14:00.000+00:00",
  "format": "JSON"
}
```

--------------------------------

### Get Interactions By IDs Request

Source: https://api-docs.observe.ai/index

Demonstrates how to retrieve interactions using their IDs. It details the query parameter 'includeTranscript' and the request body schema, which accepts either 'observe_interaction_ids' or 'partner_interaction_ids'.

```http
GET /interactions?includeTranscript=true
Content-Type: application/json

{
  "observe_interaction_ids": [
    "id1",
    "id2"
  ]
}
```

--------------------------------

### API JSON Response Sample

Source: https://api-docs.observe.ai/index

This snippet shows a typical JSON response from the API, including start and end dates, a status, and a pre-signed URL for accessing associated data. The URL contains AWS signature parameters for authentication and access control.

```json
{
  "start_date": "2022-03-03T00:00:12.000+00:00",
  "end_date": "2022-04-04T00:14:00.000+00:00",
  "status": "COMPLETED",
  "url": "https://e2e-data-out.s3.amazonaws.com/reports/ackdispute/3058bc09-6d4d-4f22-9f69-6992f3520e56.json?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220510T045319Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAJUMHAEOBEW4GINBA%2F20220510%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=c87f8c8829f8127d3485fa79a8be56c33a0ce121238c579349c867f555940c10"
}
```

--------------------------------

### Get Interactions Report Response Sample

Source: https://api-docs.observe.ai/index

This is a sample JSON response for a successful request to the get/v2/data/reports/interactions/{request_id} endpoint. It includes a URL to access the generated report, typically stored in an S3 bucket.

```json
{
  "start_date": "2022-03-03T00:00:12.000+00:00",
  "end_date": "2022-04-04T00:14:00.000+00:00",
  "status": "COMPLETED",
  "url": "https://e2e-data-out.s3.amazonaws.com/reports/interactions/3058bc09-6d4d-4f22-9f69-6992f3520e56.json?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220510T045319Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAJUMHAEOBEW4GINBA%2F20220510%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=c87f8c8829f8127d3485fa79a8be56c33a0ce121238c579349c867f555940c10"
}
```

--------------------------------

### Get Evaluations Request Status

Source: https://api-docs.observe.ai/index

This snippet shows how to poll for the status of an evaluation data request. Once completed, the response will provide access to the evaluation forms and scores.

```bash
GET /v1/evaluations/{requestId}
Host: YOUR_INSTANCE.observe.ai
Authorization: Bearer YOUR_AUTH_TOKEN
```

--------------------------------

### Observe AI API Evaluation Request Response Sample

Source: https://api-docs.observe.ai/index

This JSON response sample indicates the status of an evaluation request submitted to the Observe AI API. It includes a request ID, the specified start and end dates, and the current status of the request.

```json
{"request_id":"3058bc09-f9fc-4586-bc7c-498b95a63ec2","start_date":"2022-03-03T00:00:12.000+00:00","end_date":"2022-04-04T00:16:00.000+00:00","status":"INPROGRESS"}
```

--------------------------------

### Create Interaction Request

Source: https://api-docs.observe.ai/index

This snippet shows how to request interaction data. You need to provide a start date, end date, and format. The API supports pagination and can optionally include transcripts. The S3 URL for retrieved data is valid for 24 hours.

```json
{
  "start_date": "2022-03-03T00:00:12.000+00:00",
  "end_date": "2022-04-04T00:14:00.000+00:00",
  "format": "JSON"
}
```

--------------------------------

### Get Ack Dispute Details by IDs - Request Payload

Source: https://api-docs.observe.ai/index

This snippet shows the JSON payload structure for requesting acknowledgement dispute details. It requires a list of evaluation IDs.

```json
{
  "evaluation_ids": [
    "5e178d4246a3ce00010931d2",
    "5e73d49ff2d4540001657309"
  ]
}
```

--------------------------------

### Summarization AI API - Create Summaries Request Payload

Source: https://api-docs.observe.ai/index

This JSON payload is used to request summaries from the Summarization AI API. It includes the start and end dates for the summary period and specifies the desired output format.

```json
{
  "start_date": "2022-03-03T00:00:12.000+00:00", 
  "end_date": "2022-04-04T00:14:00.000+00:00", 
  "format": "JSON" 
}
```

--------------------------------

### Summarization AI API - Bad Request Sample

Source: https://api-docs.observe.ai/index

This code snippet provides an example of a 'bad request' response from the Summarization AI API. It indicates an error where the maximum number of interaction IDs specified has been exceeded.

```json
{"error_code":"bad_request","error_description":"Maximum observe interaction ids that can be specified is 100"}
```

--------------------------------

### Get Ack Dispute Details Request Status

Source: https://api-docs.observe.ai/index

This snippet shows how to poll for the status of a request for dispute details. Once completed, the response will contain the acknowledgment and dispute state changes.

```bash
GET /v1/disputes/{requestId}
Host: YOUR_INSTANCE.observe.ai
Authorization: Bearer YOUR_AUTH_TOKEN
```

--------------------------------

### Get Ack Dispute Details By Ids Request Status

Source: https://api-docs.observe.ai/index

This snippet demonstrates how to retrieve dispute details for multiple evaluations using their IDs. This is an asynchronous operation returning a Request ID.

```bash
POST /v1/disputes/ids
Host: YOUR_INSTANCE.observe.ai
Authorization: Bearer YOUR_AUTH_TOKEN
Content-Type: application/json

{
  "evaluationIds": ["eval_id_1", "eval_id_2"]
}
```

--------------------------------

### Get Interaction Request Status

Source: https://api-docs.observe.ai/index

This snippet demonstrates how to poll for the status of an interaction data request using the provided Request ID. Once the status is 'COMPLETED', an S3 URL for the data will be returned.

```bash
GET /v1/interactions/{requestId}
Host: YOUR_INSTANCE.observe.ai
Authorization: Bearer YOUR_AUTH_TOKEN
```

--------------------------------

### Observe AI API Create Evaluation Request Payload

Source: https://api-docs.observe.ai/index

This JSON payload is used to create an evaluation request via the Observe AI API. It includes the start date, end date, and desired format for the evaluation data.

```json
{
  "start_date": "2022-03-03T00:00:12.000+00:00",
  "end_date": "2022-04-04T00:14:00.000+00:00",
  "format": "JSON"
}
```

--------------------------------

### Get Evaluation Ack Dispute Details Response

Source: https://api-docs.observe.ai/index

Retrieves the details of an evaluation's acknowledgment and dispute status, including pagination information and a list of dispute details. The response contains information about the request, evaluation, and timeline.

```json
{"request_id":"3058bc09-f9fc-4586-bc7c-498b95a63ec2","start_date":"2022-03-03T00:00:12.000+00:00","end_date":"2022-04-04T00:16:00.000+00:00","status":"INPROGRESS"}
```

--------------------------------

### Interactions API Endpoints

Source: https://api-docs.observe.ai/index

The Interactions API uses a POST request to register a data request and returns a request ID. A subsequent GET request with the request ID is used to poll for and retrieve the reporting data. This asynchronous approach is designed to handle large volumes of data efficiently.

```HTTP
POST https://kong.observe.ai/v1/data/reports/interactions
GET https://kong.observe.ai/v1/data/reports/interactions/{request_id}
```

--------------------------------

### Create Coaching Request

Source: https://api-docs.observe.ai/index

This snippet demonstrates how to request coaching session data. This asynchronous API call returns a Request ID for monitoring the data retrieval.

```bash
POST /v1/coachings
Host: YOUR_INSTANCE.observe.ai
Authorization: Bearer YOUR_AUTH_TOKEN
Content-Type: application/json

{
  "startDate": "2023-01-01T00:00:00Z",
  "endDate": "2023-01-31T23:59:59Z"
}
```

--------------------------------

### Create Access Token

Source: https://api-docs.observe.ai/index

This snippet demonstrates how to create an access token using your App ID and App Secret. Ensure you have obtained these credentials from the Observe.AI helpdesk. The access token expires every 2 hours.

```json
{
  "app_id": "string",
  "app_secret": "string"
}
```

--------------------------------

### Create Interaction Request

Source: https://api-docs.observe.ai/index

This snippet shows how to initiate a request to fetch interaction data. This is an asynchronous operation, and the response will include a Request ID to track the status.

```bash
POST /v1/interactions
Host: YOUR_INSTANCE.observe.ai
Authorization: Bearer YOUR_AUTH_TOKEN
Content-Type: application/json

{
  "startDate": "2023-01-01T00:00:00Z",
  "endDate": "2023-01-31T23:59:59Z"
}
```

--------------------------------

### Create Evaluation Request

Source: https://api-docs.observe.ai/index

This snippet demonstrates how to request evaluation data. This asynchronous API call will return a Request ID for tracking the data retrieval process.

```bash
POST /v1/evaluations
Host: YOUR_INSTANCE.observe.ai
Authorization: Bearer YOUR_AUTH_TOKEN
Content-Type: application/json

{
  "startDate": "2023-01-01T00:00:00Z",
  "endDate": "2023-01-31T23:59:59Z"
}
```

--------------------------------

### Create Ack Dispute Request

Source: https://api-docs.observe.ai/index

This snippet demonstrates how to initiate a request to retrieve acknowledgment and dispute state changes for evaluations. The API is asynchronous and provides a Request ID.

```bash
POST /v1/disputes
Host: YOUR_INSTANCE.observe.ai
Authorization: Bearer YOUR_AUTH_TOKEN
Content-Type: application/json

{
  "evaluationId": "eval_id_1"
}
```

--------------------------------

### 200 OK Response Structure

Source: https://api-docs.observe.ai/index

This snippet illustrates the expected JSON structure for a successful API response (HTTP 200 OK). It details the fields for evaluation forms, including templates, sections, questions, and associated evaluations with their metadata and responses.

```json
{
  "evaluation_forms": [
    {
      "template": {
        "id": "String",
        "name": "String",
        "max_score": "double",
        "sections": [
          {
            "section_id": "String",
            "section_name": "String",
            "max_score": "double",
            "questions": [
              {
                "id": "String",
                "max_score": "double",
                "phrase": "String"
              }
            ]
          }
        ]
      },
      "evaluations": [
        {
          "channel_meta": {},
          "evaluation_list": [
            {
              "evaluation_meta": {
                "id": "String",
                "evaluation_type": "String",
                "evaluator_id": "String",
                "evaluator_name": "String",
                "partner_evaluator_id": "String",
                "evaluator_email": "String",
                "evaluator_status": "String",
                "evaluation_purpose": "String",
                "agent_id": "String",
                "partner_agent_id": "String",
                "ack_info": {
                  "ack_status": "String",
                  "ack_init_time": "Date",
                  "ack_time": "Date",
                  "dispute_raised_at": "Date",
                  "dispute_raised_by_email": "String",
                  "dispute_resolved_at": "Date",
                  "dispute_resolved_by_email": "String"
                },
                "agent_name": "String",
                "agent_email": "String",
                "agent_status": "String",
                "created_at": "Date",
                "modified_at": "Date",
                "status": "String"
              },
              "response": {
                "comment": "String",
                "sections": [
                  {
                    "id": "String",
                    "score_obtained": "double",
                    "questions": [
                      {
                        "id": "String",
                        "score_obtained": "double",
                        "comment": "String",
                        "fail": "boolean"
                      }
                    ]
                  }
                ]
              }
            }
          ]
        }
      ]
    }
  ]
}
```

--------------------------------

### Create Summaries Request

Source: https://api-docs.observe.ai/index

This snippet illustrates how to request AI-generated summaries for interactions. Similar to other reporting APIs, this is an asynchronous process that returns a Request ID.

```bash
POST /v1/summaries
Host: YOUR_INSTANCE.observe.ai
Authorization: Bearer YOUR_AUTH_TOKEN
Content-Type: application/json

{
  "interactionIds": ["interaction_id_1", "interaction_id_2"]
}
```

--------------------------------

### Observe.AI API Request Sample for Interaction IDs

Source: https://api-docs.observe.ai/index

This JSON payload is used to request interaction data from the Observe.AI API. It accepts lists of Observe.AI interaction IDs and partner interaction IDs to filter the results.

```json
{
  "observe_interaction_ids": [
    "af1d1b95-de6d-42db-83bd-3a585e65fcc9",
    "4909093-918a-41ab-9fe3-0d1880fa2fd3"
  ],
  "partner_interaction_ids": [
    "7f9744f08a45cb0010d3a7c8",
    "9f583739466b73001e4a125c"
  ]
}
```

--------------------------------

### Observe.AI API - Sample Request Payload

Source: https://api-docs.observe.ai/index

This JSON payload is used to request interaction data from the Observe.AI API. It accepts lists of observe_interaction_ids and partner_interaction_ids to filter the results.

```json
{
  "observe_interaction_ids": [
    "af1d1b95-de6d-42db-83bd-3a585e65fcc9",
    "4909093-918a-41ab-9fe3-0d1880fa2fd3"
  ],
  "partner_interaction_ids": [
    "7f9744f08a45cb0010d3a7c8",
    "9f583739466b73001e4a125c"
  ]
}
```

--------------------------------

### API Response 200 - Interaction Report Structure

Source: https://api-docs.observe.ai/index

Details the structure of a successful API response (HTTP 200) for interaction reports. It includes pagination information, a list of interactions, and the detailed fields within each interaction such as IDs, agent information, duration, channel, transcripts, summaries, and moment analysis.

```JSON
{
  "page": 1,
  "size": 10,
  "total_pages": 5,
  "total_size": 50,
  "interactions": [
    {
      "id": "interaction_123",
      "account_id": "account_abc",
      "agent_id": "agent_xyz",
      "partner_agent_id": "partner_agent_789",
      "agent_name": "John Doe",
      "agent_email": "john.doe@example.com",
      "agent_status": "ACTIVE",
      "interaction_url": "https://api.observe.ai/interactions/interaction_123",
      "duration": 120,
      "source_partner_meeting_id": "meeting_456",
      "sequence": 0,
      "language": "English",
      "channel": "CALL",
      "provider_id": "provider_1",
      "transcripts": [
        {
          "phrase": "Hello, how can I help you today?",
          "speaker": "Agent",
          "start_time": 1000,
          "end_time": 3000,
          "order": 0
        },
        {
          "phrase": "I would like to inquire about my bill.",
          "speaker": "customer",
          "start_time": 3500,
          "end_time": 5500,
          "order": 1
        }
      ],
      "summary": {
        "text": "Customer inquired about their bill."
      },
      "moment_categories": [
        {
          "moment_category_id": "cat_1",
          "moment_category_name": "Billing Inquiry",
          "moments": [
            {
              "moment_id": "moment_a",
              "moment_name": "Billing Question",
              "moment_theme": "Neutral",
              "found": true,
              "snippets": [
                {
                  "evidence": "inquire about my bill",
                  "start_time": 3500,
                  "end_time": 5000,
                  "order": 1
                }
              ]
            }
          ]
        }
      ],
      "created_at": "2023-10-27T10:00:00Z",
      "updated_at": "2023-10-27T10:05:00Z",
      "interaction_start_time": "2023-10-27T09:58:00Z",
      "interaction_meta_data": {
        "customer_id": "cust_789",
        "product_type": "Subscription"
      }
    }
  ]
}
```

--------------------------------

### Observe AI API Error Response Sample

Source: https://api-docs.observe.ai/index

This snippet shows a sample error response from the Observe AI API, specifically indicating a 'bad_request' error due to exceeding the maximum number of interaction IDs.

```json
{"error_code":"bad_request","error_description":"Maximum observe interaction ids that can be specified is 100"}
```

--------------------------------

### Obtain Auth Token

Source: https://api-docs.observe.ai/index

This snippet demonstrates how to obtain an authentication token using your App ID and App Secret. The token is required for all subsequent Reporting API calls and expires every 2 hours.

```bash
POST /oauth/token
Host: YOUR_INSTANCE.observe.ai
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=YOUR_APP_ID&client_secret=YOUR_APP_SECRET
```

--------------------------------

### Calls Report API Endpoint

Source: https://api-docs.observe.ai/index

The Calls Report API uses a synchronous POST request to fetch call data. This method may lead to timeouts if the volume of data requested is very large.

```HTTP
POST https://api.observe.ai/v1/reports/accounts/{account_name}/data_
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.