EvaluAgent API (1.0.6)

Download OpenAPI specification:Download

Support: support@evaluagent.com URL: https://support.evaluagent.com

Introduction

Evaluagent API

You can use the EvaluAgent API to access and update information within your EvaluAgent account. The Evaluagent API is organised around REST. REST stands for Representational State Transfer. This is an architectural pattern that describes how distributed systems can expose a consistent interface. When people use the term ‘REST API’, they are generally referring to an API accessed using the HTTP protocol at a predefined set of URLs.

These URLs represent various resources which can be returned as JSON, HTML or audio files. Often resources have one or more methods that can be performed on them over HTTP, like GET, POST, PUT and DELETE. These actions action represent the verbs Fetch, Create, Update and Delete respectively for those resources. The Evaluagent API is structured using the JSON:API specification and described using the OpenAPI specification.

In order to maintain data sovereignty our API can only be accessed regionally by cluster.

For customers on our European cluster (eu-west-1) the API URL is api.evaluagent.com.

For customers on our North America cluster (us-east) the API URL is api.us-east.evaluagent.com.

For customers on our Australian cluster (aus) the API URL is api.aus.evaluagent.com.

Changelog

4th Sep 2024

Added rate-limiting to all endpoints. Maximum is 100 requests per minute, 10,000 per day, per API key, per endpoint.

5th August 2024

Added ping endpoint for authentication details
Added support for bearer tokens

12th July 2024

Added endpoint to retrieve analytics for a single conversation

08th July 2024

Added conversational analytics reporting endpoint

14th March 2024

Added Levels Index, Abilities Index, Groups CUD, Roles CUD

30th August 2023

Added additional details on Authentication

28th March 2023

Added 'scorecard_id' to evaluations list and single evaluation endpoints

21st Feb 2023

Added the 'agent' relationship to evaluations in the 'List evaluations' endpoint

2nd February 2023

Imported Contacts endpoint: Added metadata array example

31st January 2023

Improved documentation content & layout.
Deprecated /quality/contacts endpoint.

13th December 2022

Imported Contacts endpoint: removed requirement for a responses array or audio file path.
2 December 2022
Added third_party_id property to the users endpoints
19th October 2022
New endpoint for generating an Imported Contact
New endpoint for uploading audio files
8th September 2022
On the List Groups endpoint, added an additional attribute to indicate if the group was a part of the "Custom Reporting Groups" feature.

3rd August 2022

Added the ability to import third-party contacts.

26th April 2022

Added the property 'started_at' to the Evaluation resource.

15th November 2021

The users endpoint can now return an individual user via filter search string.

13th October 2021

Added the US-East cluster endpoint

2nd March 2021

Added the outcome_name property to Evaluations. This will contain the manual outcome if manual outcomes are in use, otherwise it will contain the name of the outcome configured by the user in Quality Settings.

24th September 2020

Added the seconds_elapsed property to Evaluations

28th May 2020

Added required tags to appropriate attributes in Create a Contact

5th March 2020

Added new sorting options for evaluations
Root causes will now appear with evaluations if present
Data capture responses will now appear with evaluations if present
Adding a new metadata property to Contacts which can include additional, third party information

QuickStart

Learn how to get started with the Evaluagent API. This article describes how to quickly get started with the Evaluagent API using curl and Basic Authentication.

Install curl if it isn't already installed on your machine. To check if curl is installed, execute curl --version in the command line. If the output is information about the version of curl, it is installed. If you get a message similar to command not found: curl, you need to download and install curl. More information can be found here.
Create an Evaluagent API key in Conversations>>Integrations>>API. Take a note of the Access Key ID and Secret Key. Warning: Treat your API key like a password.
Use the curl command to make your request. Pass your token in an Authorization header. Replace YOUR-ACCESS-KEY-ID and YOU-SECRET-KEY with your Access Key ID and Secret Key respectively. curl –request GET --url "https://YOUR-CLUSTER-REGION/v1/org/users" -u "YOUR-ACCESS-KEY-ID:YOUR-SECRET-KEY"

Overview

API version

Available resources may vary between REST API versions. The current version is V1.

Schema

All API access is over HTTPS and via regional clusters

Europe: https://api.evaluagent.com.
North America: https://api.us-east.evaluagent.com.
Australia: https://api.aus.evaluagent.com.

All data is sent and received as JSON.

Blank fields are included as null instead of being omitted. All timestamps return as a String in UTC time, ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ

Guides

Using the API

About the Evaluagent API

When you make a request to the REST API, you will specify an HTTP method and a path. Additionally, you might also specify request headers and path, query, or body parameters. The API will return the response status code, response headers, and potentially a response body. The REST API reference documentation describes the HTTP method, path, and parameters for every operation. It also displays example requests and responses for each operation.

Making a request

To make a request, first find the HTTP method and the path for the operation that you want to use. For example, the "List users" operation uses the GET method and the /org/users path. Prepend the base URL for the Evaluagent API region (for example: https://api.evaluagent.com in Europe) and then the version (currently v1) to the path to get the full URL. For example: https://api.evaluagent.com/v1/org/users in Europe.

Basics of authentication

Evaluagent supports HTTP Basic authentication. API keys can be provisioned in the Evaluagent platform under Conversations>>Integrations>>API. These are needed to authenticate requests against the API.

You must pass your Access Key ID and Secret Key in an Authorization header with every request to the API in the format "Basic YOUR-ACCESS-KEY-ID:YOUR-SECRET-KEY", where YOUR-ACCESS-KEY-ID:YOUR-SECRET-KEY are Base64 encoded. Many HTTP clients will automatically format in this way for you.

Bearer Token Authentication

Alternatively, you can use the details above to generate a Bearer Token. These expire every 24 hours unless they are refreshed, providing a new token and invaliding the existing token. Once a token has been generated, Basic Authentication will be disabled for those credentials.

Authentication

Basic

HTTP Basic Auth using API Key & Secret

Security scheme type:	HTTP
HTTP Authorization Scheme	basic

Bearer

HTTP bearer token authentication

Security scheme type:	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

Ping

Check authentication status

Ping

Ping our API to verify your current authentication details

Authorizations:

BasicBearer

Responses

200

Returns authentication information

401

Unauthorized. Check your API credentials.

get /ping

Customers on our EU cluster

https://api.evaluagent.com/v1/ping

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/ping

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/ping

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"ping": "2024-01-01T00:00:00.000Z",
"ip": "127.0.0.1",
"bearer":
{
- "user": "aa0edd80-e5a5-4c68-8229-986a20d71ca0",
- "expires": "2024-01-01 00:00:00"
}

}

Tokens

Create, refresh, or expire Bearer Tokens for authentication

Create Token

Authorizations:

Basic

Responses

201

Token has been created

401

Unauthorized. Check your API credentials.

403

Forbidden. Bearer Tokens can only be created using Basic Auth.

post /token

Customers on our EU cluster

https://api.evaluagent.com/v1/token

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/token

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/token

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"token": "string",
"expiration": "2024-01-01 00:00:00"

}

Revoke Token

Invalidate the bearer token used for authentication. Please be aware that the basic authentication details that worked to create this token will continue to be unusable. This is a destructive action which will prevent future API requests associated with this key

Authorizations:

Bearer

Responses

204

Token has been successfully revoked (empty body response)

401

Unauthorized. Check your API credentials.

403

Forbidden. Must use Token authentication.

delete /token

Customers on our EU cluster

https://api.evaluagent.com/v1/token

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/token

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/token

Refresh Token

This will issue a new bearer token associated with this API key, the bearer token used for authentication will be invalidated upon issue of the new token

Authorizations:

Bearer

Responses

200

Token has been refreshed (the previous token is no longer valid)

401

Unauthorized. Check your API credentials.

403

Forbidden. Must use Token authentication.

post /token/refresh

Customers on our EU cluster

https://api.evaluagent.com/v1/token/refresh

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/token/refresh

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/token/refresh

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"token": "string",
"expiration": "2024-01-01 00:00:00"

}

Users

Fetch, create and update users

Create a user

Use this endpoint to add a new user to your Evaluagent org.

Authorizations:

BasicBearer

Request Body schema: application/json

Add a user to your Evaluagent org.

Define the Roles for this User using the Roles relationship. This can include making the user an Agent, Quality Analyst or Administrator as well as granting login access to the EvaluAgent app. A list of role ids can be found in the Roles endpoint.

If the created user is an Agent then the optional 'agent-team' relationship can be used to specify the id of the Group that they belong to. The list of Groups can be fetched using the Groups endpoint.

data

object

Responses

201

Returns the new user

400

Validation errors

401

Unauthorized. Check your API credentials.

post /org/users

Customers on our EU cluster

https://api.evaluagent.com/v1/org/users

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/org/users

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/org/users

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"data":
{
- "type": "users",
- "attributes":
  {
  - "forename": "John",
  - "surname": "Smith",
  - "email": "john.smith@example.com",
  - "username": "john.smith@example.com",
  - "active": true,
  - "allow_login": true,
  - "reporting_access_id": "ec1cf0c7-d90e-4988-b6f2-f9624eb4a5b5",
  - "third_party_id": 12345
  },
- "relationships":
  {
  - "agent-team":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "groups"
    }
    },
  - "roles":
    {
    "data":
    [
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "roles"
    }
    ]
    }
  }
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
{
- "id": "43aea3f1-00aa-4b9f-8dc4-9f843788bf41",
- "type": "users",
- "attributes":
  {
  - "forename": "John",
  - "surname": "Smith",
  - "email": "john.smith@example.com",
  - "username": "john.smith@example.com",
  - "start_date": "2024-10-22T12:44:44Z",
  - "active": true,
  - "allow_login": true,
  - "reporting_access_id": "ec1cf0c7-d90e-4988-b6f2-f9624eb4a5b5",
  - "third_party_id": "someOtherId"
  },
- "relationships":
  {
  - "agent-team":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "groups"
    }
    },
  - "roles":
    {
    "data":
    [
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "roles"
    }
    ]
    }
  }
}

}

List users

Fetch a list of all the users in this org. Filter by email address to search for a specific user.

Authorizations:

BasicBearer

query Parameters

filter[email]	string <string> Example: filter[email]=user%40company.com Return a specific user by their email address.
filter[username]	string <string> Example: filter[username]=user%40company.com Return a specific user by their username.

Responses

200

Returns an array of users

401

Unauthorized. Check your API credentials.

get /org/users

Customers on our EU cluster

https://api.evaluagent.com/v1/org/users

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/org/users

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/org/users

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
[
- {
  - "id": "43aea3f1-00aa-4b9f-8dc4-9f843788bf41",
  - "type": "users",
  - "attributes":
    {
    "forename": "John",
    "surname": "Smith",
    "email": "john.smith@example.com",
    "username": "john.smith@example.com",
    "start_date": "2024-10-22T12:44:44Z",
    "active": true,
    "allow_login": true,
    "reporting_access_id": "ec1cf0c7-d90e-4988-b6f2-f9624eb4a5b5",
    "third_party_id": "someOtherId"
    },
  - "relationships":
    {
    "agent-team":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "groups"
    }
    },
    "roles":
    {
    "data":
    [
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "roles"
    }
    ]
    }
    }
  }
]

}

Fetch a user

Fetch a specific user by userid

Authorizations:

BasicBearer

path Parameters

required

string

The id of the user to retrieve

Responses

200

Returns the specified user

401

Unauthorized. Check your API credentials.

404

User not found

get /org/users/{id}

Customers on our EU cluster

https://api.evaluagent.com/v1/org/users/{id}

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/org/users/{id}

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/org/users/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
{
- "id": "43aea3f1-00aa-4b9f-8dc4-9f843788bf41",
- "type": "users",
- "attributes":
  {
  - "forename": "John",
  - "surname": "Smith",
  - "email": "john.smith@example.com",
  - "username": "john.smith@example.com",
  - "start_date": "2024-10-22T12:44:44Z",
  - "active": true,
  - "allow_login": true,
  - "reporting_access_id": "ec1cf0c7-d90e-4988-b6f2-f9624eb4a5b5",
  - "third_party_id": "someOtherId"
  },
- "relationships":
  {
  - "agent-team":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "groups"
    }
    },
  - "roles":
    {
    "data":
    [
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "roles"
    }
    ]
    }
  }
}

}

Update an existing user

Update a user's details

Toggle state between active/deactive setting the 'active' attribute.

Define the Roles for this User using the Roles relationshop. This can include making the user an Agent, Quality Analyst or Administrator as well as granting login access to the EvaluAgent app. A list of role ids can be found in the Roles endpoint.

If the user is an Agent then the 'agent-team' relationship can be updated to move the Agent to a different group. The list of groups can be fetched using the Groups endpoint.

Authorizations:

BasicBearer

path Parameters

required

string

The id of the user to update

Request Body schema: application/json

Updated details for the user

data

object

Responses

200

Returns the updated user

400

Validation failure

401

Unauthorized. Check your API credentials.

404

User not found

patch /org/users/{id}

Customers on our EU cluster

https://api.evaluagent.com/v1/org/users/{id}

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/org/users/{id}

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/org/users/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"data":
{
- "type": "users",
- "attributes":
  {
  - "forename": "John",
  - "surname": "Smith",
  - "email": "john.smith@example.com",
  - "username": "john.smith@example.com",
  - "active": true,
  - "allow_login": true,
  - "reporting_access_id": "ec1cf0c7-d90e-4988-b6f2-f9624eb4a5b5",
  - "third_party_id": "idFromExternalSystem"
  },
- "relationships":
  {
  - "agent-team":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "groups"
    }
    },
  - "roles":
    {
    "data":
    [
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "roles"
    }
    ]
    }
  }
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
{
- "id": "43aea3f1-00aa-4b9f-8dc4-9f843788bf41",
- "type": "users",
- "attributes":
  {
  - "forename": "John",
  - "surname": "Smith",
  - "email": "john.smith@example.com",
  - "username": "john.smith@example.com",
  - "start_date": "2024-10-22T12:44:44Z",
  - "active": true,
  - "allow_login": true,
  - "reporting_access_id": "ec1cf0c7-d90e-4988-b6f2-f9624eb4a5b5",
  - "third_party_id": "someOtherId"
  },
- "relationships":
  {
  - "agent-team":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "groups"
    }
    },
  - "roles":
    {
    "data":
    [
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "roles"
    }
    ]
    }
  }
}

}

Groups

List your group hierarchy

Create a group

Use this endpoint to add a new group to your Evaluagent org.

Authorizations:

BasicBearer

Request Body schema: application/json

Add a group to your Evaluagent org. Levels can be grabbed from the org/levels endpoint.

data

object

Responses

201

Returns the new group

400

Validation errors

401

Unauthorized. Check your API credentials.

post /org/groups

Customers on our EU cluster

https://api.evaluagent.com/v1/org/groups

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/org/groups

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/org/groups

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"data":
{
- "type": "groups",
- "attributes":
  {
  - "name": "Agent",
  - "level": "7e1ff821-b744-417b-a212-58ed46457b31",
  - "active": true,
  - "parent_group": "8d1ef891-g744-417d-h212-58er47547d81"
  }
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
{
- "id": "43aea3f1-00aa-4b9f-8dc4-9f843788bf41",
- "type": "groups",
- "attributes":
  {
  - "name": "Customer Service Department",
  - "level": "Department",
  - "active": true,
  - "is_custom_reporting_group": false,
  - "parent": "7e1ff821-b744-417b-a212-58ed46457b31",
  - "has_children": true
  }
}

}

List groups

Fetch a list of your groups and their hierarchy within EvaluAgent. Useful for compiling a list of groups and their ids for managing agents.

Authorizations:

BasicBearer

query Parameters

show_inactive

boolean

Whether inactive groups should be shown. Defaults to false.

Responses

200

Returns an array of groups

401

Unauthorized. Check your API credentials.

get /org/groups

Customers on our EU cluster

https://api.evaluagent.com/v1/org/groups

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/org/groups

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/org/groups

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
[
- {
  - "id": "43aea3f1-00aa-4b9f-8dc4-9f843788bf41",
  - "type": "groups",
  - "attributes":
    {
    "name": "Customer Service Department",
    "level": "Department",
    "active": true,
    "is_custom_reporting_group": false,
    "parent": "7e1ff821-b744-417b-a212-58ed46457b31",
    "has_children": true
    }
  }
]

}

Update an existing group

Update a group's details

Authorizations:

BasicBearer

path Parameters

required

string

The id of the group to update

Request Body schema: application/json

Updated details for the group

data

object

Responses

200

Returns the updated group

400

Validation failure

401

Unauthorized. Check your API credentials.

404

Group not found

patch /org/groups/{id}

Customers on our EU cluster

https://api.evaluagent.com/v1/org/groups/{id}

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/org/groups/{id}

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/org/groups/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"data":
{
- "type": "groups",
- "attributes":
  {
  - "name": "Agent",
  - "level": "7e1ff821-b744-417b-a212-58ed46457b31",
  - "active": true,
  - "parent_group": "8d1ef891-g744-417d-h212-58er47547d81"
  }
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
{
- "id": "43aea3f1-00aa-4b9f-8dc4-9f843788bf41",
- "type": "groups",
- "attributes":
  {
  - "name": "Customer Service Department",
  - "level": "Department",
  - "active": true,
  - "is_custom_reporting_group": false,
  - "parent": "7e1ff821-b744-417b-a212-58ed46457b31",
  - "has_children": true
  }
}

}

Delete group

Authorizations:

BasicBearer

path Parameters

required

string

The ID of the group to retrieve

Responses

204

Returns nothing. Group has been deleted.

401

Unauthorized. Check your API credentials.

404

Group not found

delete /org/groups/{id}

Customers on our EU cluster

https://api.evaluagent.com/v1/org/groups/{id}

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/org/groups/{id}

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/org/groups/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data": null

}

Roles

List user roles

Create a role

Use this endpoint to add a new Role to your Evaluagent org.

Authorizations:

BasicBearer

Request Body schema: application/json

Add a role to your Evaluagent org. Abilities can be grabbed from the org/abilities endpoint.

data

object

Responses

201

Returns the new role

400

Validation errors

401

Unauthorized. Check your API credentials.

post /org/roles

Customers on our EU cluster

https://api.evaluagent.com/v1/org/roles

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/org/roles

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/org/roles

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"data":
{
- "type": "roles",
- "attributes":
  {
  - "name": "Agent"
  },
- "relationships":
  {
  - "abilities":
    {
    "data":
    [
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "abilities"
    }
    ]
    }
  }
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
{
- "id": "43aea3f1-00aa-4b9f-8dc4-9f843788bf41",
- "type": "roles",
- "attributes":
  {
  - "title": "Team Leader",
  - "name": "team-leader"
  },
- "relationships":
  {
  - "abilities":
    {
    "data":
    [
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "abilities"
    }
    ]
    }
  }
}

}

List roles

Fetch a list of your roles within EvaluAgent. Useful for assigning roles to users.

Authorizations:

BasicBearer

Responses

200

Returns an array of roles

401

Unauthorized. Check your API credentials.

get /org/roles

Customers on our EU cluster

https://api.evaluagent.com/v1/org/roles

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/org/roles

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/org/roles

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
[
- {
  - "id": "43aea3f1-00aa-4b9f-8dc4-9f843788bf41",
  - "type": "roles",
  - "attributes":
    {
    "title": "Team Leader",
    "name": "team-leader"
    },
  - "relationships":
    {
    "abilities":
    {
    "data":
    [
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "abilities"
    }
    ]
    }
    }
  }
]

}

Update an existing role

Update a role's details

Authorizations:

BasicBearer

path Parameters

required

string

The id of the role to update

Request Body schema: application/json

Updated details for the role

data

object

Responses

200

Returns the updated role

400

Validation failure

401

Unauthorized. Check your API credentials.

404

Role not found

patch /org/roles/{id}

Customers on our EU cluster

https://api.evaluagent.com/v1/org/roles/{id}

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/org/roles/{id}

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/org/roles/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"data":
{
- "type": "roles",
- "attributes":
  {
  - "name": "Admin"
  },
- "relationships":
  {
  - "abilities":
    {
    "data":
    [
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "abilities"
    }
    ]
    }
  }
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
{
- "id": "43aea3f1-00aa-4b9f-8dc4-9f843788bf41",
- "type": "roles",
- "attributes":
  {
  - "title": "Team Leader",
  - "name": "team-leader"
  },
- "relationships":
  {
  - "abilities":
    {
    "data":
    [
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "abilities"
    }
    ]
    }
  }
}

}

Delete role

Authorizations:

BasicBearer

path Parameters

required

string

The ID of the role to retrieve

Responses

204

Returns nothing. Role has been deleted.

401

Unauthorized. Check your API credentials.

404

Role not found

delete /org/roles/{id}

Customers on our EU cluster

https://api.evaluagent.com/v1/org/roles/{id}

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/org/roles/{id}

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/org/roles/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data": null

}

Levels

List levels

Fetch a list of your levels within EvaluAgent. Useful for creating groups.

Authorizations:

BasicBearer

Responses

200

Returns an array of levels

401

Unauthorized. Check your API credentials.

get /org/levels

Customers on our EU cluster

https://api.evaluagent.com/v1/org/levels

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/org/levels

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/org/levels

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
[
- {
  - "id": "43aea3f1-00aa-4b9f-8dc4-9f843788bf41",
  - "type": "levels",
  - "attributes":
    {
    "name": "Business"
    }
  }
]

}

Abilities

List abilities

Fetch a list of your abilities within EvaluAgent. Useful for creating roles.

Authorizations:

BasicBearer

Responses

200

Returns an array of abilities

401

Unauthorized. Check your API credentials.

get /org/abilities

Customers on our EU cluster

https://api.evaluagent.com/v1/org/abilities

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/org/abilities

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/org/abilities

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
[
- {
  - "id": "43aea3f1-00aa-4b9f-8dc4-9f843788bf41",
  - "type": "abilities",
  - "attributes":
    {
    "heading": "User Management Permissions",
    "title": "Manage Users"
    }
  }
]

}

Evaluations

List and query evaluations

List evaluations

Fetch a list of your completed evaluations and their results. The request can be filtered by date and sorted by published_at, date_published, updated_at, reference, score, agent_name, evaluator_name. The endpoint also supports pagination, requests default to the first page. If you also need the related contacts for the evaluations then use include to also return those contacts with the request.

Authorizations:

BasicBearer

query Parameters

filter[published_at;between]	string <date-time> Example: filter[published_at;between]=2023-05-01T00%3A00%3A00.000Z%2C%202023-08-01T00%3A00%3A00.000Z A date range to filter evaluations on their `published_at` date. Consists of a comma-separated start and end date in UTC format.
sort	string Example: sort=-published_at An option to sort by order of choice. Adding a minus operator to the start of field you wish to sort on will return results descending order. List of sorting options - `published_at`, `date_published`, `updated_at`, `reference`, `score`, `agent_name`, `evaluator_name`
page[number]	number Example: page[number]=1 When paginated, the page number that you would like to request. Defaults to 1.
include	string Example: include=contacts Request that contacts associated with the returned evaluations be included under the "included" key in the response.

Responses

200

Returns an array of evaluations

401

Unauthorized. Check your API credentials.

get /quality/evaluations

Customers on our EU cluster

https://api.evaluagent.com/v1/quality/evaluations

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/quality/evaluations

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/quality/evaluations

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
[
- {
  - "id": "43aea3f1-00aa-4b9f-8dc4-9f843788bf41",
  - "type": "evaluations",
  - "attributes":
    {
    "published_at": "2024-10-22T12:44:44Z",
    "updated_at": "2024-10-22T12:44:44Z",
    "notes": "string",
    "mode": "Official Evaluation",
    "status": "string",
    "scorecard": "Customer Service Scorecard v1",
    "scorecard_id": "43aea3f1-00aa-4b9f-8dc4-9f843788bf41",
    "outcome": "Pass",
    "outcome_name": "Fair",
    "num_of_autofails": 0,
    "quality_score": "87.4",
    "seconds_elapsed": 1776,
    "started_at": "2024-10-22T12:44:44Z"
    },
  - "relationships":
    {
    "evaluator":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "users"
    }
    },
    "contact":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "contacts"
    }
    },
    "agent":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "agents"
    }
    }
    }
  }
]

}

Fetch an evaluation

Fetch a detailed view of an evaluation, including feedback and individual line item scores. Use include to also return related contacts and evaluators or agents for this specific evaluation.

Authorizations:

BasicBearer

path Parameters

required

string

The id of the evaluation to retrieve

query Parameters

include

Array of strings

Items Enum: "contact" "evaluator" "agent"

Example: include=contact,evaluator,agent

A comma-separated list of records associated with the evaluation to be included under the "included" key in the response. Available record types are contact, evaluator, and agent.

Responses

200

Returns the evaluation

401

Unauthorized. Check your API credentials.

404

Evaluation not found

get /quality/evaluations/{id}

Customers on our EU cluster

https://api.evaluagent.com/v1/quality/evaluations/{id}

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/quality/evaluations/{id}

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/quality/evaluations/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
{
- "id": "43aea3f1-00aa-4b9f-8dc4-9f843788bf41",
- "type": "evaluations",
- "attributes":
  {
  - "published_at": "2024-10-22T12:44:44Z",
  - "updated_at": "2024-10-22T12:44:44Z",
  - "notes": "string",
  - "mode": "Official Evaluation",
  - "status": "string",
  - "scorecard": "Customer Service Scorecard v1",
  - "scorecard_id": "43aea3f1-00aa-4b9f-8dc4-9f843788bf41",
  - "outcome": "Pass",
  - "outcome_name": "Fair",
  - "num_of_autofails": 0,
  - "quality_score": "87.4",
  - "seconds_elapsed": 1776,
  - "started_at": "2024-10-22T12:44:44Z",
  - "category_results":
    [
    {
    "id": "43aea3f1-00aa-4b9f-8dc4-9f843788bf41",
    "name": "Customer Experience",
    "result": "100.0"
    }
    ],
  - "evaluation_feedback":
    [
    {
    "type": "Neutral",
    "feedback": "Feedback for agent"
    }
    ],
  - "line_items":
    [
    {
    "id": "43aea3f1-00aa-4b9f-8dc4-9f843788bf41",
    "name": "Did the agent open the call correctly?",
    "categories":
    [
    {
    "name": "Customer Experience"
    }
    ],
    "weighting": "1",
    "auto_fail_setting": false,
    "score": "0.5",
    "outcome_title": "Exceeds",
    "system_outcome": "Pass",
    "line_item_feedback":
    [
    {
    "type": "Neutral",
    "feedback": "Feedback for agent"
    }
    ],
    "root_cause": "Agent did not get marketing permissions"
    }
    ],
  - "data_capture_responses":
    [
    {
    "id": "8c752858-02ce-473a-b1ef-47a5c42c76a5",
    "question_id": "3568d086-f228-4c03-af4b-52bb5c90794b",
    "question_text": "Branch location",
    "answer": "London",
    "is_freetext": false,
    "created_at": "2024-10-22T12:44:44Z"
    }
    ]
  },
- "relationships":
  {
  - "evaluator":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "users"
    }
    },
  - "contact":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "contacts"
    }
    },
  - "agent":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "agents"
    }
    }
  }
}

}

Imported Contacts

Import conversations and contacts from external platforms into EvaluAgent

Generate an imported contact

Use this endpoint to import conversations from other platforms into Evaluagent.

For text-only conversations use this endpoint as is.
For conversations that include a recorded audio file you will need to first use the /quality/imported-contacts/upload-audio endpoint to upload that audio file. Then using the returned path reference use this endpoint to import the related metadata for your conversation.

Please note there is rate-limiting in place for this endpoint. Maximum 100 requests per-minute, based on API credentials.

Authorizations:

BasicBearer

Request Body schema: application/json

Contact to add to EvaluAgent.

data

object

Responses

200

Your imported contact was successfully created in EvaluAgent.

400

Validation errors

401

Unauthorized. Check your API credentials.

post /quality/imported-contacts

Customers on our EU cluster

https://api.evaluagent.com/v1/quality/imported-contacts

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/quality/imported-contacts

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/quality/imported-contacts

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"data":
{
- "reference": "string",
- "agent_id": "string",
- "agent_email": "string",
- "contact_date": "2024-10-22T12:44:44Z",
- "channel": "Email",
- "assigned_at": "2024-10-22T12:44:44Z",
- "solved_at": "2024-10-22T12:44:44Z",
- "handling_time": 120,
- "external_url": "https://evaluagent.com",
- "customer_telephone_number": "01753 877212",
- "audio_file_path": "string",
- "metadata":
  {
  - "Direction": "inbound",
  - "Campaign": "new-campaign"
  },
- "responses":
  [
  - {
    "speaker_id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "speaker_email": "string",
    "response_id": "515235",
    "message": "Hi, I’ve been trying to resolve an issue regarding my online account.",
    "channel": "Email",
    "message_created_at": "2022-09-01T00:00:00Z",
    "speaker_is_customer": true
    }
  ]
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"status": 200,
"message": "Success",
"contact_reference": "a63e026f-50ea-42c8-9fa1-418b4427a10c",
"3rd_party_reference": "contact001"

}

Upload audio

Use this endpoint to import recorded audio file conversations from other platforms into Evaluagent.

Use the path reference in the response from this endpoint when importing the related metadata with the /quality/imported-contacts endpoint.

The Evaluagent platform supports all audio encoded in a format supported by HTML5

Authorizations:

BasicBearer

Request Body schema: multipart/form-data

audio_file

required

null <binary>

The audio file to upload. Must be an MP3, WAV, OGG, M4A, etc.

Responses

200

Your audio file was successfully uploaded to EvaluAgent.

400

Validation errors

401

Unauthorized. Check your API credentials.

post /quality/imported-contacts/upload-audio

Customers on our EU cluster

https://api.evaluagent.com/v1/quality/imported-contacts/upload-audio

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/quality/imported-contacts/upload-audio

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/quality/imported-contacts/upload-audio

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"status": 200,
"message": "Audio file uploaded successfully",
"path": "quality/fb2db7c0-de00-43ed-997d-f587eac8bdbb/55649393-f708-4ebf-a665-a39942c030f1.mp3"

}

Conversational Analytics

Retrieve analytics data for your conversations over a specified period

Get Conversational Analytics

Fetch conversational analytics for contacts between a specified time period

Authorizations:

BasicBearer

query Parameters

filter[contact_date;between] required	string <date-time> Example: filter[contact_date;between]=2023-05-01T00%3A00%3A00.000Z%2C%202023-05-31T00%3A00%3A00.000Z A date range to filter conversations on their `contact_date`. Consists of a comma-separated start and end date in UTC format.
filter[insight_topics][]	array <string> Example: filter[insight_topics][]=13686037-e52e-470a-966c-843437e7d422 An array of topic UUIDs to filter conversations by
sort	string Example: sort=-contact_date An option to sort by order of choice. Adding a minus operator to the start of field you wish to sort on will return results descending order. List of sorting options - `contact_date`
page[number]	number Example: page[number]=1 When paginated, the page number that you would like to request. Defaults to 1.

Responses

200

Returns an array of conversational analytics records

400

Validation errors

401

Unauthorized. Check your API credentials.

get /analytics/conversations?filter[contact_date;between]

Customers on our EU cluster

https://api.evaluagent.com/v1/analytics/conversations?filter[contact_date;between]

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/analytics/conversations?filter[contact_date;between]

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/analytics/conversations?filter[contact_date;between]

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
[
- {
  - "id": "43aea3f1-00aa-4b9f-8dc4-9f843788bf41",
  - "type": "conversational_analytics",
  - "attributes":
    {
    "contact_date": "2024-10-22T12:44:44Z",
    "3rd_party_reference": "ABC123",
    "source_id": 123456,
    "channel": "Salesforce",
    "agent_id": "string",
    "agent_name": "John Smith",
    "handle_time": 306,
    "response_count": 12,
    "has_audio": true,
    "silence_duration": 62,
    "overtalk_instances": 2,
    "xnps_outcome": "string",
    "reason_for_contact": "string",
    "sentiment":
    {
    "sentiment_score": 0,
    "agent_sentiment_label": "string",
    "agent_sentiment_score": 0,
    "customer_sentiment_label": "string",
    "customer_sentiment_score": 0
    },
    "ai":
    {
    "ai_opening": "string",
    "ai_requirements": "string",
    "ai_discussion": "string",
    "ai_outcome": "string"
    },
    "topics": "{'Topic Name': 'Pass', 'Another Topic': 'Fail', 'Final Topic': ''}"
    }
  }
]

}

Get Conversation

Fetch conversational analytics for a specific contact

Authorizations:

BasicBearer

path Parameters

required

string

The id of the conversation to retrieve

Responses

200

Returns analytics for a single conversation

401

Unauthorized. Check your API credentials.

404

Conversation not found

get /analytics/conversations/{id}

Customers on our EU cluster

https://api.evaluagent.com/v1/analytics/conversations/{id}

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/analytics/conversations/{id}

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/analytics/conversations/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"id": "43aea3f1-00aa-4b9f-8dc4-9f843788bf41",
"type": "conversational_analytics",
"attributes":
{
- "contact_date": "2024-10-22T12:44:44Z",
- "3rd_party_reference": "ABC123",
- "source_id": 123456,
- "channel": "Salesforce",
- "agent_id": "string",
- "agent_name": "John Smith",
- "handle_time": 306,
- "response_count": 12,
- "has_audio": true,
- "silence_duration": 62,
- "overtalk_instances": 2,
- "xnps_outcome": "string",
- "reason_for_contact": "string",
- "sentiment":
  {
  - "sentiment_score": 0,
  - "agent_sentiment_label": "string",
  - "agent_sentiment_score": 0,
  - "customer_sentiment_label": "string",
  - "customer_sentiment_score": 0
  },
- "ai":
  {
  - "ai_opening": "string",
  - "ai_requirements": "string",
  - "ai_discussion": "string",
  - "ai_outcome": "string"
  },
- "topics": "{'Topic Name': 'Pass', 'Another Topic': 'Fail', 'Final Topic': ''}"
}

}

Templates

List Work Queue Templates

Fetch a list of Work Queue Templates in this org.

Authorizations:

BasicBearer

Responses

200

Returns a list of Work Queue Templates

401

Unauthorized. Check your API credentials.

get /work-queues/templates

Customers on our EU cluster

https://api.evaluagent.com/v1/work-queues/templates

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/work-queues/templates

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/work-queues/templates

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
[
- {
  - "id": "8cba1b19-4cbb-4247-8ed4-6f94753c56d6",
  - "type": "template",
  - "attributes":
    {
    "name": "My Work Queue Template",
    "status": "active",
    "cycle_type": "daily",
    "cycle_value": 1,
    "cycle_month_day": 15,
    "created_at": "2024-10-22T12:44:44Z"
    },
  - "relationships":
    {
    "agent":
    {
    "data":
    [
    {
    "id": "c98c1599-7f9d-4206-92f5-85e5dd2576e8",
    "type": "users"
    },
    {
    "id": "2c63916a-1591-48a8-8584-9efd30dc3178",
    "type": "users"
    }
    ]
    }
    }
  }
]

}

Fetch a Work Queue Template

Fetch a specific Work Queue Template by ID

Authorizations:

BasicBearer

path Parameters

required

string

The ID of the Work Queue Template to retrieve

Responses

200

Returns the specified Work Queue Template

401

Unauthorized. Check your API credentials.

404

Work Queue Template not found

get /work-queues/templates/{id}

Customers on our EU cluster

https://api.evaluagent.com/v1/work-queues/templates/{id}

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/work-queues/templates/{id}

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/work-queues/templates/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
{
- "id": "8cba1b19-4cbb-4247-8ed4-6f94753c56d6",
- "type": "template",
- "attributes":
  {
  - "name": "My Work Queue Template",
  - "status": "active",
  - "cycle_type": "daily",
  - "cycle_value": 1,
  - "cycle_month_day": 15,
  - "created_at": "2024-10-22T12:44:44Z"
  },
- "relationships":
  {
  - "agent":
    {
    "data":
    [
    {
    "id": "c98c1599-7f9d-4206-92f5-85e5dd2576e8",
    "type": "users"
    },
    {
    "id": "2c63916a-1591-48a8-8584-9efd30dc3178",
    "type": "users"
    }
    ]
    }
  }
}

}

Fetch Agents assigned to a Work Queue Template

Fetch a specific Work Queue Template by the given ID

Authorizations:

BasicBearer

path Parameters

required

string

The ID of the Work Queue Template to retrieve

Responses

200

Returns the agents assigned to the specified Work Queue Template

401

Unauthorized. Check your API credentials.

404

Work Queue Template not found

get /work-queues/templates/{id}/relationships/agents

Customers on our EU cluster

https://api.evaluagent.com/v1/work-queues/templates/{id}/relationships/agents

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/work-queues/templates/{id}/relationships/agents

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/work-queues/templates/{id}/relationships/agents

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
[
- {
  - "type": "users",
  - "id": "154d0f4a-d274-4660-87be-077443297638"
  }
]

}

Update Agents assigned to a Work Queue Template

Sync Agents assigned to the given Work Queue Template. Agents assigned to the Work Queue Template will be updated to match the given data, removing any assigned agents if not included in the data.

Authorizations:

BasicBearer

path Parameters

required

string

The ID of the Work Queue Template to retrieve

Responses

200

Returns the updated Work Queue Template

401

Unauthorized. Check your API credentials.

404

Work Queue Template not found

patch /work-queues/templates/{id}/relationships/agents

Customers on our EU cluster

https://api.evaluagent.com/v1/work-queues/templates/{id}/relationships/agents

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/work-queues/templates/{id}/relationships/agents

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/work-queues/templates/{id}/relationships/agents

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
[
- {
  - "type": "users",
  - "id": "154d0f4a-d274-4660-87be-077443297638"
  }
]

}

Add Agents assigned to a Work Queue Template

Add agents assigned to the Work Queue Template

Authorizations:

BasicBearer

path Parameters

required

string

The ID of the Work Queue Template to retrieve

Responses

200

Returns the updated Work Queue Template

401

Unauthorized. Check your API credentials.

404

Work Queue Template not found

post /work-queues/templates/{id}/relationships/agents

Customers on our EU cluster

https://api.evaluagent.com/v1/work-queues/templates/{id}/relationships/agents

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/work-queues/templates/{id}/relationships/agents

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/work-queues/templates/{id}/relationships/agents

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
[
- {
  - "type": "users",
  - "id": "154d0f4a-d274-4660-87be-077443297638"
  }
]

}

Delete Agents assigned to a Work Queue Template

Delete Agents assigned to the given Work Queue Template

Authorizations:

BasicBearer

path Parameters

required

string

The ID of the Work Queue Template to retrieve

Responses

200

Returns the updated Work Queue Template

401

Unauthorized. Check your API credentials.

404

Work Queue Template not found

delete /work-queues/templates/{id}/relationships/agents

Customers on our EU cluster

https://api.evaluagent.com/v1/work-queues/templates/{id}/relationships/agents

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/work-queues/templates/{id}/relationships/agents

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/work-queues/templates/{id}/relationships/agents

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
[
- {
  - "type": "users",
  - "id": "154d0f4a-d274-4660-87be-077443297638"
  }
]

}

Topics

Manage 121 Topics

List 121 Topics

Fetch a list of 121 Topics specific to the API Key's contract.

Authorizations:

BasicBearer

Responses

200

Returns a list of 121 Topics

401

Unauthorized. Check your API key and secret are correct. Every API call requires Basic Auth.

get /one-to-ones/topics

Customers on our EU cluster

https://api.evaluagent.com/v1/one-to-ones/topics

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/one-to-ones/topics

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/one-to-ones/topics

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
[
- {
  - "id": "string",
  - "type": "one-to-one-topics",
  - "attributes":
    {
    "name": "string",
    "active": true,
    "colour": "string"
    }
  }
]

}

One To Ones

View & manage your 121s

List 121s

Fetch a list of your 121s and associated details. The request can be filtered by date and sorted by published_at, date_published, created_at, updated_at, reference, score, agent_name, evaluator_name. The endpoint also supports pagination, requests default to the first page.

Authorizations:

BasicBearer

query Parameters

filter[created_at;between]	string <date-time> Example: filter[created_at;between]=2023-05-01T00%3A00%3A00.000Z%2C%202023-08-01T00%3A00%3A00.000Z A date range to filter 121s on their created_at date. Consists of a comma-separated start and end date in UTC format.
filter[scheduled_date;between]	string <date-time> Example: filter[scheduled_date;between]=2023-05-01T00%3A00%3A00.000Z%2C%202023-08-01T00%3A00%3A00.000Z A date range to filter 121s on their scheduled_date. Consists of a comma-separated start and end date in UTC format.
filter[completed_at;between]	string <date-time> Example: filter[completed_at;between]=2023-05-01T00%3A00%3A00.000Z%2C%202023-08-01T00%3A00%3A00.000Z A date range to filter 121s on their completed_at date. Consists of a comma-separated start and end date in UTC format.
filter[participant]	string Example: filter[participant]=99abbc05-9535-4e20-84be-0d4e55bcd407 Unique user ID to filter 121 participants by
filter[facilitator]	string Example: filter[facilitator]=99abbc05-9535-4e20-84be-0d4e55bcd407 Unique user ID to filter 121 facilitators by
sort	string Enum: "scheduled_date" "started_at" "completed_at" "topic" "participant" Example: sort=-scheduled_date Sort the returned 121s. Adding a minus operator to the start of field you wish to sort on will return results descending order.
page[number]	number Example: page[number]=1 When paginated, the page number that you would like to request. Defaults to 1.

Responses

200

Returns an array of evaluations

401

Unauthorized. Check your API key and secret are correct. Every API call requires Basic Auth.

get /one-to-ones

Customers on our EU cluster

https://api.evaluagent.com/v1/one-to-ones

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/one-to-ones

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/one-to-ones

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data":
[
- {
  - "id": "string",
  - "type": "one-to-ones",
  - "attributes":
    {
    "location": "string",
    "reference": "string",
    "started_at": null,
    "created_at": null,
    "scheduled_date": null,
    "completed_at": null,
    "description": "string",
    "prep_notes": "string",
    "acknowledgement_time": null,
    "facilitator_comments": "string",
    "participant_comments": "string",
    "online_meeting": true,
    "status": "string",
    "private": true,
    "participant_can_view_before": true,
    "duration_hours": 0,
    "duration_minutes": 0,
    "end_datetime_from_duration": null,
    "total_duration_minutes": 0,
    "third_party_id": 0,
    "date": null
    },
  - "relationships":
    {
    "facilitator":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "users"
    }
    },
    "participant":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "users"
    }
    },
    "topic":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "one_to_one_topics"
    }
    },
    "actions":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "one_to_one_actions"
    }
    }
    }
  }
]

}

Create 121

Create a new 121

Authorizations:

BasicBearer

Request Body schema: application/json

Create a new 121

data

object

Responses

200

Returns an object containing details for the newly-created 121.

401

Unauthorized. Check your API key and secret are correct. Every API call requires Basic Auth.

post /one-to-ones

Customers on our EU cluster

https://api.evaluagent.com/v1/one-to-ones

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/one-to-ones

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/one-to-ones

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"data":
{
- "type": "one-to-ones",
- "attributes":
  {
  - "duration_hours": 0,
  - "duration_minutes": 0,
  - "duration_location": "string",
  - "meeting_config":
    {
    "meet_now": true
    },
  - "participant_can_view_before": true,
  - "private": true,
  - "started_at": null,
  - "status": "completed_acknowledged",
  - "timezone": "Europe/London",
  - "type": "face-to-face"
  },
- "relationships":
  {
  - "facilitator":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "users"
    }
    },
  - "participant":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "users"
    }
    },
  - "topic":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "one_to_one_topics"
    }
    },
  - "actions":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "one_to_one_actions"
    }
    }
  }
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"id": "string",
"type": "one-to-ones",
"attributes":
{
- "location": "string",
- "reference": "string",
- "started_at": null,
- "created_at": null,
- "scheduled_date": null,
- "completed_at": null,
- "description": "string",
- "prep_notes": "string",
- "acknowledgement_time": null,
- "facilitator_comments": "string",
- "participant_comments": "string",
- "online_meeting": true,
- "status": "string",
- "private": true,
- "participant_can_view_before": true,
- "duration_hours": 0,
- "duration_minutes": 0,
- "end_datetime_from_duration": null,
- "total_duration_minutes": 0,
- "third_party_id": 0,
- "date": null
},
"relationships":
{
- "facilitator":
  {
  - "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "users"
    }
  },
- "participant":
  {
  - "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "users"
    }
  },
- "topic":
  {
  - "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "one_to_one_topics"
    }
  },
- "actions":
  {
  - "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "one_to_one_actions"
    }
  }
}

}

Fetch 121

Retrieve details for a single 121.

Authorizations:

BasicBearer

path Parameters

id	string Example: 99abbc05-9535-4e20-84be-0d4e55bcd407 Unique identifier for a single 121 record

Responses

200

Returns an object containing details for the 121 requested.

401

Unauthorized. Check your API key and secret are correct. Every API call requires Basic Auth.

404

121 not found

get /one-to-ones/{id}

Customers on our EU cluster

https://api.evaluagent.com/v1/one-to-ones/{id}

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/one-to-ones/{id}

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/one-to-ones/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"id": "string",
"type": "one-to-ones",
"attributes":
{
- "location": "string",
- "reference": "string",
- "started_at": null,
- "created_at": null,
- "scheduled_date": null,
- "completed_at": null,
- "description": "string",
- "prep_notes": "string",
- "acknowledgement_time": null,
- "facilitator_comments": "string",
- "participant_comments": "string",
- "online_meeting": true,
- "status": "string",
- "private": true,
- "participant_can_view_before": true,
- "duration_hours": 0,
- "duration_minutes": 0,
- "end_datetime_from_duration": null,
- "total_duration_minutes": 0,
- "third_party_id": 0,
- "date": null
},
"relationships":
{
- "facilitator":
  {
  - "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "users"
    }
  },
- "participant":
  {
  - "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "users"
    }
  },
- "topic":
  {
  - "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "one_to_one_topics"
    }
  },
- "actions":
  {
  - "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "one_to_one_actions"
    }
  }
}

}

Update 121

Update the 121 with the specified details

Authorizations:

BasicBearer

Request Body schema: application/json

Updated details for the 121

data

object

Responses

200

Returns an object containing details for the updated 121.

401

Unauthorized. Check your API key and secret are correct. Every API call requires Basic Auth.

404

121 not found

patch /one-to-ones/{id}

Customers on our EU cluster

https://api.evaluagent.com/v1/one-to-ones/{id}

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/one-to-ones/{id}

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/one-to-ones/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{

"data":
{
- "type": "one-to-ones",
- "attributes":
  {
  - "duration_hours": 0,
  - "duration_minutes": 0,
  - "duration_location": "string",
  - "meeting_config":
    {
    "meet_now": true
    },
  - "participant_can_view_before": true,
  - "private": true,
  - "started_at": null,
  - "status": "completed_acknowledged",
  - "timezone": "Europe/London",
  - "type": "face-to-face"
  },
- "relationships":
  {
  - "facilitator":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "users"
    }
    },
  - "participant":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "users"
    }
    },
  - "topic":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "one_to_one_topics"
    }
    },
  - "actions":
    {
    "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "one_to_one_actions"
    }
    }
  },
- "id": "string"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"id": "string",
"type": "one-to-ones",
"attributes":
{
- "location": "string",
- "reference": "string",
- "started_at": null,
- "created_at": null,
- "scheduled_date": null,
- "completed_at": null,
- "description": "string",
- "prep_notes": "string",
- "acknowledgement_time": null,
- "facilitator_comments": "string",
- "participant_comments": "string",
- "online_meeting": true,
- "status": "string",
- "private": true,
- "participant_can_view_before": true,
- "duration_hours": 0,
- "duration_minutes": 0,
- "end_datetime_from_duration": null,
- "total_duration_minutes": 0,
- "third_party_id": 0,
- "date": null
},
"relationships":
{
- "facilitator":
  {
  - "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "users"
    }
  },
- "participant":
  {
  - "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "users"
    }
  },
- "topic":
  {
  - "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "one_to_one_topics"
    }
  },
- "actions":
  {
  - "data":
    {
    "id": "ea0c8aab-dc5b-4d7e-b2bc-364250679278",
    "type": "one_to_one_actions"
    }
  }
}

}

Delete 121

Delete the specified 121

Authorizations:

BasicBearer

Responses

204

No response.

401

Unauthorized. Check your API key and secret are correct. Every API call requires Basic Auth.

404

121 not found

delete /one-to-ones/{id}

Customers on our EU cluster

https://api.evaluagent.com/v1/one-to-ones/{id}

Customers on our Australian cluster

https://api.aus.evaluagent.com/v1/one-to-ones/{id}

Customers on our North American (US-East) cluster

https://api.us-east.evaluagent.com/v1/one-to-ones/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"data": null

}

EvaluAgent API (1.0.6)

Introduction

Evaluagent API

Changelog

4th Sep 2024

5th August 2024

12th July 2024

08th July 2024

14th March 2024

30th August 2023

28th March 2023

21st Feb 2023

2nd February 2023

31st January 2023

13th December 2022

2 December 2022

19th October 2022

8th September 2022

3rd August 2022

26th April 2022

15th November 2021

13th October 2021

2nd March 2021

24th September 2020

28th May 2020

5th March 2020

QuickStart

Overview

API version

Schema

Guides

Using the API

About the Evaluagent API

Making a request

Basics of authentication

Bearer Token Authentication

Authentication

Basic

Bearer

Ping

Ping

Authorizations:

Responses

Response samples

Tokens

Create Token

Authorizations:

Responses

Response samples

Revoke Token

Authorizations:

Responses

Refresh Token

Authorizations:

Responses

Response samples

Users

Create a user

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

List users

Authorizations:

query Parameters

Responses

Response samples

Fetch a user

Authorizations:

path Parameters

Responses

Response samples

Update an existing user

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples