These are a couple of articles in our help center that will show you where to get your API keys and how to get started. To see code samples and details of how to structure an API call, click on Feedback requests on the left to get started.
\nWe offer a number of turn-key integrations that don't require you to get into the weeds of our APIs:
\nZendesk
\nKustomer
\nSalesforce
\nFreshdesk
\nDesk.com
\nand plenty more through the use of Zapier
\nSee all of our turn-key integrations
\nMany of our clients find value in bringing Agent Connect data back into their internal systems for additional analysis. This data can be piped in to several different types of systems:
\nData warehouses
\nWorkforce management
\nMarketing automation
\nCustomer experience management (CEM) platforms
\nSee our API documentation for detailed instructions.
\nThe Agent Connect API uses API keys to authenticate requests to send surveys and uses API keys and JSON Web Token (jwt) to retrieve survey and response data.
\nEach client is provided two API keys (one test key and one production key). These keys can be generated and retrieved within the Agent Connect platform by an Admin user by navigating to Settings > Integrations
\nAll requests that are not authenticated properly will fail. Requests must be made over HTTPS, not plain HTTP.
\nAuthentication to the request and recoveries endpoints is made by using the api key in the \"x-api-key\" Header.
\nDetails about Data return can be found on in our help center.
\nIn order to make sure our APIs are always available and healthy, some APIs are throttled. This means there is a limit to the amount of requests that can be made in a certain timeframe.
\nWhen throttled, the API will return status code: 429 with a message body: Retry Later.
In the case that you are making a high volume of requests in a short timeframe it's best practice to setup your client code to handle this error and retry again after a specified wait period.
\nCurrently we have limits of 100 requests/min per API key on the follow routes:
\n/v1/data/requests
\n/v1/data/responses
\nCreate a service recovery request
\n","urlObject":{"protocol":"https","path":["v1","recoveries"],"host":["subdomain","api","stellaconnect","net"],"query":[],"variable":[]}},"response":[{"id":"5e7fac48-c851-4544-9c80-7bc310bb60ec","name":"Response_200","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"[insert your API key here]"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"do_not_send\": true,\r\n \"tags\": [\r\n \"tags\"\r\n ],\r\n \"employee\": {\r\n \"custom_id\": \"6598260\",\r\n \"email\": \"samantha@blancapeak.com\"\r\n },\r\n \"initial_feedback_request_id\": \"54bd2af9-28cb-48df-8c60-cd27de080cd4\",\r\n \"ext_interaction_id\": \"64664523\",\r\n \"external_url\": \"https://blancapeak.your-source-system.com/cases/64664523\"\r\n}"},"url":"https://subdomain.api.stellaconnect.net/v1/recoveries","description":"Create a service recovery request"},"status":"Recovery created","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"cookie":[],"responseTime":null,"body":"{\r\n \"request_id\": \"ea4b0c98-560d-43a6-a12d-298eabcb5141\"\r\n}"},{"id":"de592eeb-8f8a-4583-b64d-2c2c57beb05e","name":"Response_400","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"[insert your API key here]"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"do_not_send\": true,\r\n \"tags\": [\r\n \"tags\"\r\n ],\r\n \"employee\": {\r\n \"custom_id\": \"6598260\",\r\n \"email\": \"samantha@blancapeak.com\"\r\n },\r\n \"initial_feedback_request_id\": \"54bd2af9-28cb-48df-8c60-cd27de080cd4\",\r\n \"ext_interaction_id\": \"64664523\",\r\n \"external_url\": \"https://blancapeak.your-source-system.com/cases/64664523\"\r\n}"},"url":"https://subdomain.api.stellaconnect.net/v1/recoveries","description":"Create a service recovery request"},"status":"Parsing/validation errors","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"cookie":[],"responseTime":null,"body":"{\r\n \"validation_errors\": [\r\n \"validation_errors\"\r\n ]\r\n}"}],"_postman_id":"e9fd2fc0-0973-48ec-9c80-ef82b4990a35"}],"id":"badeb48d-a8fc-47c7-95cc-f1b3c271f9f8","event":[{"listen":"prerequest","script":{"id":"191adfc2-fbd7-46fb-aad0-ef399fe4afb8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9564773f-c00f-4297-bb9b-de92d9dbccce","type":"text/javascript","exec":[""]}}],"_postman_id":"badeb48d-a8fc-47c7-95cc-f1b3c271f9f8","description":""},{"name":"User provisioning","item":[{"name":"Status / error codes","item":[],"id":"2e13eba3-1adb-4162-993e-22be5bcebf8b","description":"","event":[{"listen":"prerequest","script":{"id":"15dcac39-441b-48ee-807c-72d3417f1720","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"75bd10b0-8368-47e9-9017-9856d0fe9762","type":"text/javascript","exec":[""]}}],"_postman_id":"2e13eba3-1adb-4162-993e-22be5bcebf8b"},{"name":"Activate Employee","id":"5ddf6304-dd27-4555-8bfc-3fd45c765804","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"[insert your token here]","description":"Token
\n","type":"text"},{"key":"x-api-key","value":"[insert your API key here]","description":"Production API Key
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://subdomain.api.stellaconnect.net/v2/employees/:id/activate","description":"Activate a deactivated employee
\nid is either email or custom employee id of the employee
Email or custom ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"5ddf6304-dd27-4555-8bfc-3fd45c765804"},{"name":"Employee","id":"5ae4f417-0013-4737-ab85-971fa2063fb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"[insert your token here]","description":"Token
\n"},{"key":"x-api-key","value":"[insert your API key here]","description":"Production API Key
\n"},{"key":"Content-Type","value":"application/json"}],"url":"https://subdomain.api.stellaconnect.net/v2/employees/:id","description":"Get an employee by email or custom employee id.
\n{\n \"email\": \"jane@example.com\",\n \"custom_employee_id\": \"f157b797f9e6b3d8bf95\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"team_leader_id\": 142,\n \"team_leader_email\": “paul@example.com\",\n \"role\": \"Team Member [Default]\",\n \"license_type\": \"standard\",\n \"channels\": [\"phone\"],\n \"employment_status\": \"full-time\",\n \"start_date\": \"2023-02-05\",\n \"hometown\": \"Springfield\",\n \"state_or_country\": \"Missouri\",\n \"profile_text\": \"this is a bio of an employee\",\n \"image\": \"https://res.cloudinary.com/a-profile-pic.jpg\",\n \"groups\": [\n \"GroupA\",\n \"EmployeeGroupA\"\n ],\n \"manage_team\": false,\n \"last_active\": \"2025-01-05T15:38:54.640Z\",\n}\n\nEmail or custom ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"5ae4f417-0013-4737-ab85-971fa2063fb8"},{"name":"Employees","id":"abb24c24-6b5e-4e65-8d09-457d44a28a42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"[insert your token here]","description":"Token
\n"},{"key":"x-api-key","value":"[insert your API key here]","description":"Production API Key
\n"},{"key":"Content-Type","value":"application/json"}],"url":"https://subdomain.api.stellaconnect.net/v2/employees?external_id&number_of_employees","description":"Get all employees with pagination.
\n{\n \"employees\":\n [\n {\n \"email\": \"someone_51@tipjar.com\",\n \"custom_employee_id\": \"488b04dff664d73f1e9e\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"team_leader_id\": 114,\n \"team_leader_email\": \"team_leader@example.com\",\n \"role\": \"Team Member [Default]\",\n \"license_type\": \"standard\",\n \"channels\":[\n \"phone\"\n ],\n \"employment_status\": \"full-time\",\n \"start_date\": \"2023-02-05\",\n \"hometown\": \"Springfield\",\n \"state_or_country\": \"Missouri\",\n \"profile_text\": \"this is a bio of an employee\",\n \"image\": \"https://res.cloudinary.com/a-profile-pic.jpg\",\n \"groups\":[\n \"GroupA\",\n \"EmployeeGroupA\"\n ],\n \"manage_team\": false\n \"last_active\": \"2025-01-05T15:38:54.640Z\",\n }\n ],\n \"meta\":\n {\n \"next_page\": \"https://<subdomain>.stellaconnect.net/api/v2/employees?after=<id>\"\n }\n}\n\nThe response also returns metadata with the next page url, that can be used separately too.
\n\"meta\": {\n \"next_page\": https://<subdomain>.stellaconnect.net/api/v2/employees?after=<id>\n}\n\nParam is OPTIONAL
\nExternal id of the last employee in current paginated response. Is used to build the next page of employees.
\n","type":"text/plain"},"key":"external_id","value":null},{"description":{"content":"Param is OPTIONAL
\nDefault value is 100.\nMax value is 500.\nSets the amount of employees that will be returned during each request.
\n","type":"text/plain"},"key":"number_of_employees","value":null},{"disabled":true,"description":{"content":"Param is OPTIONAL
\nFilters the users returned based on their status
\nOptions are:
\nParam is OPTIONAL
\nFilters the users returned based on their employment status
\nOptions are:
\nParam is OPTIONAL
\nFilters the users returned based on team
Use team leader's numerical id as the value\nAdd multiple params to return employees from multiple teams
Param is OPTIONAL
\nFilters the users returned based on reporting group
Use reporting group's name as the value\nAdd multiple params to return employees from multiple reporting groups
Param is OPTIONAL
\nFilters the users returned based on role \nUse role's name as the value\nAdd multiple params to return employees from multiple roles
\n","type":"text/plain"},"key":"roles[]","value":null},{"disabled":true,"description":{"content":"Param is OPTIONAL
\nReturns employees that partially matches value\nSearches by employee's name, email address, and custom employee id
\n","type":"text/plain"},"key":"q","value":null}],"variable":[]}},"response":[],"_postman_id":"abb24c24-6b5e-4e65-8d09-457d44a28a42"},{"name":"Deactivate Employee","id":"d21afb34-f37a-4677-bf47-879cdebb158f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"description":"Token
\n","key":"Authorization","type":"text","value":"[insert your token here]"},{"description":"Production API Key
\n","key":"x-api-key","type":"text","value":"[insert your API key here]"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://subdomain.api.stellaconnect.net/v2/employees/:id/deactivate","description":"Deactivate an active employee
\nid is either email or custom employee id of the employee
Email or custom_employee_id of the employee
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"d21afb34-f37a-4677-bf47-879cdebb158f"},{"name":"Invite Employee","id":"830386f4-a1b2-467b-b958-910fa999176e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"[insert your token here]","description":"Token
\n","type":"text"},{"key":"x-api-key","value":"[insert your API key here]","description":"Production API Key
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"jane@example.com\",\n \"custom_employee_id\": \"12345\",\n \"first_name\": \"Paul\",\n \"last_name\": \"Jones\",\n \"temporary_password\": \"Password\",\n \"team_leader_id\": \"54321\",\n \"team_leader_email\": \"teamleader@example.com\",\n \"role\": \"Team Member [Default]\",\n \"manage_team\": false,\n \"license_type\": \"standard\",\n \"channels\": [\"chat\", \"email\", \"phone\"],\n \"employment_status\": \"fulltime\",\n \"start_date\": \"YYYY-MM-DD\",\n \"hometown\": \"New York\",\n \"state_or_country\": \"USA\",\n \"profile_text\": \"this is a bio of an employee\", \n \"image\": \"https://domain.com/image.png\",\n \"groups\": [\"Group A\", \"Group B\"]\n}\n"},"url":"https://subdomain.api.stellaconnect.net/v2/employees/invite","description":"Invited employees will receive a welcome email and be asked to complete their own profile. Employees invited with all attributes required to send requests, will be created in the system as employees who can send requests.
\nToken
\n","key":"Authorization","type":"text","value":"[insert your token here]"},{"description":"Production API Key
\n","key":"x-api-key","type":"text","value":"[insert your API key here]"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"jane@example.com\",\n \"custom_employee_id\": \"12345\",\n \"first_name\": \"Paul\",\n \"last_name\": \"Jones\",\n \"temporary_password\": \"Password\",\n \"team_leader_id\": \"54321\",\n \"team_leader_email\": \"teamleader@example.com\",\n \"role\": \"Team Member [Default]\",\n \"manage_team\": false,\n \"license_type\": \"standard\",\n \"channels\": [\"chat\", \"email\", \"phone\"],\n \"employment_status\": \"fulltime\",\n \"start_date\": \"YYYY-MM-DD\",\n \"hometown\": \"New York\",\n \"state_or_country\": \"USA\",\n \"profile_text\": \"this is a bio of an employee\", \n \"image\": \"https://domain.com/image.png\",\n \"groups\": [\"Group A\", \"Group B\"]\n}\n"},"url":"https://subdomain.api.stellaconnect.net/v2/employees","description":"Create a new employee
\nToken
\n","key":"Authorization","type":"text","value":"[insert your token here]"},{"description":"Production API Key
\n","key":"x-api-key","type":"text","value":"[insert your API key here]"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"jane@example.com\",\n \"custom_employee_id\": \"12345\",\n \"first_name\": \"Paul\",\n \"last_name\": \"Jones\",\n \"temporary_password\": \"Password\",\n \"team_leader_id\": \"54321\",\n \"team_leader_email\": \"teamleader@example.com\",\n \"role\": \"Team Member [Default]\",\n \"manage_team\": false,\n \"license_type\": \"standard\",\n \"channels\": [\"chat\", \"email\", \"phone\"],\n \"employment_status\": \"fulltime\",\n \"start_date\": \"YYYY-MM-DD\",\n \"hometown\": \"New York\",\n \"state_or_country\": \"USA\",\n \"profile_text\": \"this is a bio of an employee\", \n \"image\": \"https://domain.com/image.png\",\n \"reporting_groups\": [\"Group A\", \"Group B\"],\n \"permissions\": [\"view_exports\", \"approve_pending_profiles\"]\n}\n"},"url":"https://subdomain.api.stellaconnect.net/v2/employees/:id","description":"Update an existing employee
\nMissing fields will not be updated. All fields provided in the update will be completed as a full replace.
\nid is either email or custom employee id of the employee
Email or custom_employee_id of the employee
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"daf0d567-d1d3-44ea-b6f1-e37ace49ad4d"}],"id":"6445baec-fe40-45e1-8542-439de728fbe6","description":"Agent Connect offers multiple user provisioning APIs, allowing you to add, remove, and transfer users across teams.
\n","event":[{"listen":"prerequest","script":{"id":"c2fd4113-03fa-4d0f-bdf2-c9a07434a07b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d3326b6f-214a-439d-b2e1-5ca6706b1ff7","type":"text/javascript","exec":[""]}}],"_postman_id":"6445baec-fe40-45e1-8542-439de728fbe6"},{"name":"Data Return","item":[{"name":"1:1 Coaching Sessions","id":"0c9db6c5-bc08-4a0d-8a6b-a0499dd0f1b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"[insert your token here]","description":"Token
\n"},{"key":"x-api-key","value":"[insert your API key here]","description":"Production API Key
\n"}],"body":{"mode":"raw","raw":"[\n {\n \"uuid\": \"085104d5-4c81-4382-8c6b-0f86f7681f7\",\n \"created_at\": \"2025-10-27 00:07:42 UTC\",\n \"shared_at\": \"2025-10-29 00:17:07 UTC\",\n \"reshared_at\": \"2025-10-30 00:18:35 UTC\",\n \"archived\": false,\n \"sequence_id\": 17597135275535,\n \"coach\": {\n \"custom_id\": \"null\",\n \"email\": \"john@blankapeak.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\"\n },\n \"employee\": {\n \"custom_id\": \"null\",\n \"email\": \"harry@blankapeak.com\",\n \"first_name\": \"Harry\",\n \"last_name\": \"Jackson\",\n \"team_leader\": {\n \"custom_id\": \"null\",\n \"email\": \"john@blankapeak.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\"\n }\n },\n \"title\": \"Weekly 1:1 // October 30\",\n \"private\": false,\n \"created_action_items\": [\n {\n \"text\": \"Take a deep breath before each call this week and try to keep your speaking pace even and avoid speaking over the customer so they do not feel rushed\",\n \"category\": \"Empathy & Friendliness\",\n \"status\": \"open\",\n \"created_at\": \"2025-10-27 00:07:42 UTC\",\n \"completed_at\": null,\n \"due_date\": null,\n \"owner\": {\n \"custom_id\": \"null\",\n \"email\": \"harry@blankapeak.com\",\n \"first_name\": \"Harry\",\n \"last_name\": \"Jackson\"\n }\n }\n ],\n \"completed_action_items\": [\n {\n \"text\": \"Work on your empathy - try to complete the Empathy training module on Lessonly\",\n \"category\": \"Empathy & Friendliness\",\n \"status\": \"completed\",\n \"created_at\": \"2025-10-13 00:11:17 UTC\",\n \"completed_at\": \"2025-10-29 00:20:43 UTC\",\n \"due_date\": \"2025-10-31 06:00:00 UTC\",\n \"owner\": {\n \"custom_id\": \"null\",\n \"email\": \"harry@blankapeak.com\",\n \"first_name\": \"Harry\",\n \"last_name\": \"Jackson\"\n }\n }\n ],\n \"kudos\": [\n {\n \"text\": \"Amazing work improving your QA Score this week!\",\n \"created_at\": \"2025-10-27 18:50:53 UTC\"\n }\n ],\n \"metric_attachments\": [\n {\n \"name\": \"Percent Resolved\",\n \"score\": 80.0,\n \"start_date\": \"2025-10-21 06:00:00 UTC\",\n \"end_date\": \"2025-10-28 06:00:00 UTC\",\n \"added_at\": \"2025-10-28 14:27:16 UTC\",\n \"notes\": null\n },\n {\n \"name\": \"Star Rating\",\n \"score\": 4.64,\n \"start_date\": \"2025-10-21 06:00:00 UTC\",\n \"end_date\": \"2025-10-28 06:00:00 UTC\",\n \"added_at\": \"2025-10-28 14:27:16 UTC\",\n \"notes\": null\n }\n ],\n \"feedback_attachments\": [\n {\n \"uuid\": \"085104d5-4c81-4381-8c6b-0f86f7681f7\",\n \"interaction_id\": \"113752\",\n \"added_at\": \"2025-10-28 23:49:05 UTC\",\n \"notes\": null\n }\n ],\n \"qa_review_attachments\": [\n {\n \"uuid\": \"085104d5-4c81-4382-8c6b-0f86f7681f7\",\n \"interaction_id\": \"1\",\n \"added_at\": \"2025-10-28 07:55:13 UTC\",\n \"notes\": null\n }\n ]\n }\n]"},"url":"https://subdomain.api.stellaconnect.net/v2/coaching/sessions","description":"You can retrieve 1:1 Coaching Sessions from any time period for which you have been using Agent Connect QA, 1,000 records max.
\nThere is no default QA Data Return time period. If you do not specify a time period or filter by Sequence ID, then Data Return will retrieve all data starting from the first record, max 1,000 records.
\nTo request data from a specific time period, include optional parameters in your request.
\nDate Parameters:created_at_gte ; i.e. greater than or equal to created at datecreated_at_lte; i.e. less than or equal to created at date
shared_at_gte ; i.e. greater than or equal to shared at dateshared_at_lte; i.e. less than or equal to shared at date
Date Formats
Dates should be submitted in ISO_8601 format, with an appropriate timezone offset from UTC.
Specifically: YYYY-MM-DDTHH:MM:SS±HH:MM
Example: Midnight, Tuesday, December 20th, 2019 Eastern Standard Time
2019-12-20T00:00:00-05:00
All data will have a Sequence ID that can be used to filter data. Any update to an existing review will be stamped with an updated Sequence ID to allow for return of data updates.
\nWe recommend using the Sequence ID to retrieve data to ensure that you have a complete and updated data set. The Sequence ID filter should only be used if you can handle duplicates in your data.
\nSequence ID Parameters:after; i.e. after sequence id number
Example: ?after=1000
Data Returned
All data returned will be in JSON format.
Token
\n","type":"text"},{"key":"x-api-key","value":"[insert your API key here]","description":"Production API Key
\n","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"uuid\":\"1c52b4f7-a7ff-4917-a044-ebdfd34d616f\",\n \"interaction_id\":\"1\",\n \"interaction_url\":\"https://blancapeak.zendesk.com/tickets/1\",\n \"completed_at\":\"2019-12-20 10:44:18 UTC\",\n \"count_toward_score\":true,\n \"score\":\"100%\",\n \"autofailed\":false,\n \"solicitation_id\":\"1e67a757-1355-4ebd-a5eb-asdfaad\",\n \"sequence_id\":15768386581438,\n \"scorecard\":{\n \"name\":\"Chat Form\",\n \"archived_at\":null\n },\n \"employee\":{\n \"custom_id\":null,\n \"email\":\"harry@blancapeak.com\",\n \"first_name\":\"Harry\",\n \"last_name\":\"Jackson\",\n \"team_leader\":{\n \"custom_id\":null,\n \"email\":\"john@blancapeak.com\",\n \"first_name\":\"John\",\n \"last_name\":\"Smith\"\n }\n },\n \"reviewer\":{\n \"custom_id\":null,\n \"email\":\"john@balncapeak.com\",\n \"first_name\":\"John\",\n \"last_name\":\"Smith\"\n },\n \"questions\":{\n \"1\":{\n \"question_text\":\"Did the agent make an empathy statement?\",\n \"section\":null,\n \"section_weight\":null,\n \"comment\":\"Harry really connected with the customer!\",\n \"selected_options\":{\n \"1\":{\n \"option_text\":\"Yes\",\n \"score\":10\n }\n }\n },\n \"2\":{\n \"question_text\":\"Did the agent address the customer by his/her first name?\",\n \"section\":null,\n \"section_weight\":null,\n \"comment\":null,\n \"selected_options\":{\n \"4\":{\n \"option_text\":\"No\",\n \"score\":0\n }\n }\n }\n }\n }\n]\n"},"url":"https://subdomain.api.stellaconnect.net/v2/qa","description":"You can retrieve reviews from any time period for which you have been using Agent Connect QA, 1,000 records max.
\nThere is no default QA Data Return time period. If you do not specify a time period or filter by sequence id then Data Return will retrieve all data starting from the first record, max 1000 records.
\nTo request data from a specific time period, include optional parameters in your request.
\nDate Parameters:created_at_gte ; i.e. greater than or equal to created at datecreated_at_lte; i.e. less than or equal to created at date
Date Formatscreated_at_gte and created_at_lte should be submitted in ISO_8601 format, with an appropriate timezone offset from UTC.
Specifically: YYYY-MM-DDTHH:MM:SS±HH:MM
Example: Midnight, Tuesday, December 20th, 2019 Eastern Standard Time
2019-12-20T00:00:00-05:00
All data will have a sequence ID that can be used to filter data. Any update to an existing review will be stamped with an updated sequence ID to allow for return of data updates.
\nWe recommend using the sequence ID to retrieve data to ensure that you have a complete and updated data set. The sequence ID filter should only be used if you can handle duplicates in your data.
\nSequence ID Parameters:after; i.e. after sequence id number
Example: ?after=1000
Data Returned
All data returned will be in JSON format.
Token
\n"},{"key":"x-api-key","value":"[insert your API key here]","description":"Production API Key
\n"}],"body":{"mode":"raw","raw":"[\n {\n \"uuid\": \"4452b4f7-a7ff-4917-a044-ebdfd34d616f\",\n \"audit_type\": \"Audit\",\n \"interaction_id\": \"1\",\n \"interaction_url\": \"https://blancapeak.zendesk.com/ticket/1\",\n \"completed_at\": \"\",\n \"count_toward_score\": true,\n \"score\": 80,\n \"autofailed\": false,\n \"sequence_id\": 25768386581438,\n \"scorecard\": {\n \"name\": \"Audit Form\",\n \"archived_at\": null\n },\n \"reviewer\": {\n \"custom_id\": null,\n \"email\": \"harry@blancapeak.com\",\n \"first_name\": \"Harry\",\n \"last_name\": \"Jackson\",\n \"team_leader\": {\n \"custom_id\": null,\n \"email\": \"john@blancapeak.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\"\n }\n },\n \"groups\": [\n \"New Hires\",\n \"Vendor\"\n ],\n \"auditor\": {\n \"custom_id\": null,\n \"email\": \"john@balncapeak.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\"\n },\n \"questions\": {\n \"1\": {\n \"question_text\": \"Did the agent make an empathy statement?\",\n \"section\": null,\n \"section_weight\": null,\n \"comment\": \"Harry really connected with the customer!\",\n \"selected_options\": {\n \"1\": {\n \"option_text\": \"Yes\",\n \"score\": 10\n }\n }\n },\n \"2\": {\n \"question_text\": \"Did the agent address the customer by his/her first name?\",\n \"section\": null,\n \"section_weight\": null,\n \"comment\": null,\n \"selected_options\": {\n \"4\": {\n \"option_text\": \"No\",\n \"score\": 0\n }\n }\n }\n },\n \"qa_review\": {\n \"uuid\": \"1c52b4f7-a7ff-4917-a044-ebdfd34d616f\",\n \"interaction_id\": \"1\",\n \"interaction_url\": \"https://blancapeak.zendesk.com/tickets/1\",\n \"completed_at\": \"2019-12-20 10:44:18 UTC\",\n \"count_toward_score\": true,\n \"score\": \"100%\",\n \"autofailed\": false,\n \"solicitation_id\": \"1e67a757-1355-4ebd-a5eb-asdfaad\",\n \"sequence_id\": 15768386581438,\n \"scorecard\": {\n \"name\": \"Chat Form\",\n \"archived_at\": null\n },\n \"employee\": {\n \"custom_id\": null,\n \"email\": \"harry@blancapeak.com\",\n \"first_name\": \"Harry\",\n \"last_name\": \"Jackson\",\n \"team_leader\": {\n \"custom_id\": null,\n \"email\": \"john@blancapeak.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\"\n }\n },\n \"reviewer\": {\n \"custom_id\": null,\n \"email\": \"john@balncapeak.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\"\n },\n \"questions\": {\n \"1\": {\n \"question_text\": \"Did the agent make an empathy statement?\",\n \"section\": null,\n \"section_weight\": null,\n \"comment\": \"Harry really connected with the customer!\",\n \"selected_options\": {\n \"1\": {\n \"option_text\": \"Yes\",\n \"score\": 10\n }\n }\n },\n \"2\": {\n \"question_text\": \"Did the agent address the customer by his/her first name?\",\n \"section\": null,\n \"section_weight\": null,\n \"comment\": null,\n \"selected_options\": {\n \"4\": {\n \"option_text\": \"No\",\n \"score\": 0\n }\n }\n }\n }\n }\n }\n]"},"url":"https://subdomain.api.stellaconnect.net/v2/qa/audits","description":"You can retrieve audits from any time period for which you have been using Agent Connect QA, 1,000 records max.
\nThere is no default QA Data Return time period. If you do not specify a time period or filter by sequence id then Data Return will retrieve all data starting from the first record, max 1000 records.
\nTo request data from a specific time period, include optional parameters in your request.
\nDate Parameters:created_at_gte ; i.e. greater than or equal to created at datecreated_at_lte; i.e. less than or equal to created at date
completed_at_gte ; i.e. greater than or equal to completed at datecompleted_at_lte; i.e. less than or equal to completed at date
Date Formats
Dates should be submitted in ISO_8601 format, with an appropriate timezone offset from UTC.
Specifically: YYYY-MM-DDTHH:MM:SS±HH:MM
Example: Midnight, Tuesday, December 20th, 2019 Eastern Standard Time
2019-12-20T00:00:00-05:00
All data will have a sequence ID that can be used to filter data. Any update to an existing review will be stamped with an updated sequence ID to allow for return of data updates.
\nWe recommend using the sequence ID to retrieve data to ensure that you have a complete and updated data set. The sequence ID filter should only be used if you can handle duplicates in your data.
\nSequence ID Parameters:after; i.e. after sequence id number
Example: ?after=1000
Data Returned
All data returned will be in JSON format.
Token
\n"},{"key":"x-api-key","value":"[insert your API key here]","description":"Production API Key
\n"}],"body":{"mode":"raw","raw":"[\n {\n \"uuid\": \"4452b4f7-a7ff-4917-a044-ebdfd34d616f\",\n \"alignment_score\": 50,\n \"sequence_id\": 25768386581438,\n \"started_by\": {\n \"custom_id\": \"hjackson\",\n \"email\": \"harry@blancapeak.com\",\n \"first_name\": \"Harry\",\n \"last_name\": \"Jackson\"\n },\n \"meeting_date\": \"2025-01-05 04:00:00 UTC\",\n \"interaction_id\": \"1\",\n \"interaction_url\": \"https://blancapeak.zendesk.com/1\",\n \"participants\": [\n {\n \"custom_id\": \"hjackson\",\n \"email\": \"harry@blancapeak.com\",\n \"first_name\": \"Harry\",\n \"last_name\": \"Jackson\"\n },\n {\n \"custom_id\": \"jsmith\",\n \"email\": \"john@blancapeak.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\"\n }\n ],\n \"notes\": null,\n \"scorecard\": {\n \"name\": \"Email\",\n \"archived_at\": null\n },\n \"completed_at\": \"2025-01-05 14:00:00 UTC\",\n \"created_at\": \"2025-01-04 13:00:00 UTC\",\n \"questions\": {\n \"1\": {\n \"question_text\": \"Did the agent make an emptahy statement?\",\n \"section\": \"Empathy\",\n \"section_weight\": 20,\n \"question_alignment_score\": 50,\n \"selected_option\": {\n \"qa_option_id\": \"1\",\n \"option_text\": \"True\",\n \"score\": 20\n },\n \"options\": {\n \"1\": {\n \"option_text\": \"True\",\n \"score\": 20,\n \"participants\": [\n {\n \"employee\": {\n \"custom_id\": \"jsmith\",\n \"email\": \"john@blancapeak.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\"\n },\n \"comment\": \"Really nice job!\"\n }\n ]\n },\n \"2\": {\n \"option_text\": \"False\",\n \"score\": 0,\n \"participants\": [\n {\n \"employee\": {\n \"custom_id\": \"hjackson\",\n \"email\": \"harry@blancapeak.com\",\n \"first_name\": \"Harry\",\n \"last_name\": \"Jackson\"\n },\n \"comment\": \"Statement could use improvement\"\n }\n ]\n },\n \"3\": {\n \"option_text\": \"NA\",\n \"score\": 20,\n \"participants\": []\n }\n }\n }\n }\n }\n]"},"url":"https://subdomain.api.stellaconnect.net/v2/qa/calibrations","description":"You can retrieve calibrations from any time period for which you have been using Agent Connect QA, 1,000 records max.
\nThere is no default QA Data Return time period. If you do not specify a time period or filter by sequence id then Data Return will retrieve all data starting from the first record, max 1000 records.
\nTo request data from a specific time period, include optional parameters in your request.
\nDate Parameters:created_at_gte ; i.e. greater than or equal to created at datecreated_at_lte; i.e. less than or equal to created at date
completed_at_gte ; i.e. greater than or equal to completed at datecompleted_at_lte; i.e. less than or equal to completed at date
Date Formats
Dates should be submitted in ISO_8601 format, with an appropriate timezone offset from UTC.
Specifically: YYYY-MM-DDTHH:MM:SS±HH:MM
Example: Midnight, Tuesday, December 20th, 2019 Eastern Standard Time
2019-12-20T00:00:00-05:00
All data will have a sequence ID that can be used to filter data. Any update to an existing review will be stamped with an updated sequence ID to allow for return of data updates.
\nWe recommend using the sequence ID to retrieve data to ensure that you have a complete and updated data set. The sequence ID filter should only be used if you can handle duplicates in your data.
\nSequence ID Parameters:after; i.e. after sequence id number
Example: ?after=1000
Data Returned
All data returned will be in JSON format.
Token
\n"},{"key":"x-api-key","value":"[insert your API key here]","description":"Production API Key
\n","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"uuid\": \"085104d5-4c81-4382-8c6b-0f86f76871f7\",\n \"sequence_id\": 15784246365520,\n \"parent_uuid\": null,\n \"branding\": \"blancapeak\",\n \"channel\": \"email\",\n \"ext_interaction_id\": \"113752\",\n \"external_url\": \"https://blancapeak.zendesk.com/agent/tickets/113752\",\n \"language\": \"en\",\n \"survey_id\": 100,\n \"survey_name\": \"Feedback\",\n \"tags\": [\n \"deliveries\",\n \"holidays\"\n ],\n \"request_created_at\": \"2020-01-03T17:00:01.000Z\",\n \"request_delivery_status\": \"Sent\",\n \"request_sent_at\": \"2020-01-03T17:00:05.000Z\",\n \"requested_via\": \"API\",\n \"response_received_at\": \"2020-01-03T17:35:00.000Z\",\n \"reward_eligible\": false,\n \"reward_name\": null,\n \n \"marketing\": {\n \"custom_link_eligible\": false,\n \"custom_link_initiated\": false,\n \"facebook_follow_eligible\": false,\n \"facebook_follow_initiated\": false,\n \"facebook_share_eligible\": false,\n \"facebook_share_initiated\": false,\n \"twitter_follow_eligible\": false,\n \"twitter_follow_initiated\": false,\n \"twitter_share_eligible\": false,\n \"twitter_share_initiated\": false\n },\n \n \"employee\": {\n \"custom_id\": \"1471332\",\n \"email\": \"admin@blancapeak.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\"\n },\n \n \"team_leader\": {\n \"custom_id\": \"6592299\",\n \"full_name\": \"Alice Jones\"\n },\n \n \"customer\": {\n \"custom_id\": null,\n \"email\": \"janedoe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \n \"custom_properties\": null,\n \n \"answers\": {\n \"agent_star_rating\": {\n \"question_id\": 145,\n \"question_text\": \"How satisfied are you with the service you received from {{ employee.first_name }} today?\",\n \"comment\": \"John was exceptionally friendly and knowledgeable.\",\n \"selected_options\": {\n \"1072\": {\n \"option_id\": 1072,\n \"option_text\": \"5\",\n \"integer_value\": 5\n }\n }\n },\n \n \"areas_of_excellence\": {\n \"question_id\": 146,\n \"question_text\": \"What did {{ employee.first_name }} do particularly well?\",\n \"comment\": null,\n \"selected_options\": {\n \"1121\": {\n \"option_id\": 1121,\n \"option_text\": \"Friendly\",\n \"integer_value\": null\n },\n \"1123\": {\n \"option_id\": 1123,\n \"option_text\": \"Knowledgeable\",\n \"integer_value\": null\n },\n \"1127\": {\n \"option_id\": 1127,\n \"option_text\": \"Helpful\",\n \"integer_value\": null\n },\n }\n },\n \n \"nps\": {\n \"question_id\": 148,\n \"question_text\": \"How likely is it that you would recommend {{ brand.name }} to a friend or colleague?\",\n \"comment\": null,\n \"selected_options\": {\n \"1143\": {\n \"option_id\": 1143,\n \"option_text\": \"8\",\n \"integer_value\": 8\n }\n }\n },\n \n \"fcr\": {\n \"question_id\": 152,\n \"question_text\": \"Were we able to resolve your issue today?\",\n \"comment\": \"This is the third time I've emailed support.\",\n \"selected_options\": {\n \"1180\": {\n \"option_id\": 1180,\n \"option_text\": \"Yes\",\n \"integer_value\": null\n }\n }\n }\n }\n },\n {...},\n {...}\n]"},"url":"https://subdomain.api.stellaconnect.net/v2/data?limit=5","description":"Agent Connect now has an updated Data Return. v2 of our Data Return includes some enhancements to our V1 version, including:
\nAn ability to return service recovery data
\nAn ability to return custom property information
\nAn enhanced request process for retrieving record updates
\nAn improved format that supports an unlimited number of survey questions
\nTo start using Agent Connect’s Data Return API, you will need:
\nYour company’s production API key. This is the same API key used for the Request API, available to your Agent Connect Administrator via the Integrations page
\nYour company’s API secret. This is also available to your Connect Administrator via a downloadable secret key file on the Integrations page
\nIf you need your secret regenerated, please contact your client services manager.
\nA JSON Web Token, signed with your company's API secret using HMAC SHA256, and containing a valid iat claim (https://tools.ietf.org/html/rfc7519#section-4.1.6), must be provided via the Authorization header. Your company's API key must be provided via the x-api-key header. Both headers are required.
\nAuthorization: <JWT>\nx-api-key: <API Key>\n\nBy default, the endpoint returns a maximum of 1,000 interactions per request. This limit may be controlled using the limit parameter. Because requesting a large number of interactions at once can cause your request to time out, we recommend—if you are not using HTTP streaming—paging through requests, 1,000 at a time.
\nInteractions are ordered by a sequence ID number. The sequence ID is derived from the timestamp of the last update to the interaction—including updates from survey responses, and the interaction's underlying system ID (to reduce collisions); the higher the sequence ID, the more recently the interaction was updated. You may filter to interactions with sequence IDs higher than a specific one using the after parameter. This allows you to indefinitely page through interactions, receiving updated interactions as they are updated in our system.
\nTo page through interactions, pass the sequence ID of the last interaction of the last response as the after parameter of your next request.
\nIf your HTTP client supports it, you may use HTTP streaming to begin processing interactions before the request has completed. Because our web server does not have to hold interactions in memory after they have been streamed to your client, a much higher limit is supported; it may be possible to iterate through your company's entire list of interactions in a single request.
\nThis feature is experimental, and you should only use it if you know what you are doing. Due to server deploys, the connection will not remain open indefinitely. The stream parameter controls streaming.
\nAll data returned will be in JSON format.
\nParameters may be provided in the query string to the request. All datetimes should be formatted according to ISO 8601.
\nIf responded_at_gte or responded_at_lte is provided, only interactions with survey responses are returned. This may be used to filter to interactions with survey responses; if no lower bound is desired, use the UNIX epoch: 1970-01-01T00:00:00Z.
Agent Connect offers a Data Return API to allow you to retrieve QA reviews or feedback request/response data programmatically into your own systems.
\n","event":[{"listen":"prerequest","script":{"id":"7ca3f74e-02d8-42dd-b43c-67c24aa9a5ed","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1631ef12-1b4c-4313-a1b3-a0c6f735d541","type":"text/javascript","exec":[""]}}],"_postman_id":"7eb1874b-bab7-465c-8639-a30357e02902"},{"name":"External Non-Interaction Metrics","item":[{"name":"Create record","id":"6bb4e7b5-c1e8-4651-bc54-f7dbbf0930d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"[insert your token here]","type":"text"},{"key":"x-api-key","value":"[insert your API key here]","type":"text"}],"body":{"mode":"raw","raw":"{\n \"record\": {\n \"tickets_closed\": \"13\",\n \"hours_worked\": \"16\",\n \"record_date\": \"2021-06-29\",\n \"employee_id\": \"employee15@example.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://subdomain.api.stellaconnect.net/v2/integrations/:id/records","description":"The record attribute is a JSON object that has the mapped fields for the External Metric(s) configured for your company.
We require fields for the employee identifier (either email address and custom ID) and record date (in ISO-8601 date format, ex: \"YYYY-MM-DD\") as well as the fields that pertain to your metric configuration.
\n","urlObject":{"protocol":"https","path":["v2","integrations",":id","records"],"host":["subdomain","api","stellaconnect","net"],"query":[],"variable":[{"description":{"content":"The Integration ID provided by Agent Connect
\n","type":"text/plain"},"type":"any","value":"[insert your Iintegration ID here]","key":"id"}]}},"response":[],"_postman_id":"6bb4e7b5-c1e8-4651-bc54-f7dbbf0930d7"}],"id":"7e48a6c8-b5b3-4108-a2af-e4c19324fb12","description":"Please review our Help Center article that outlines our new External Non-Interaction Metric API.
\nAt this time, to begin sending us data via this API you must coordinate with our implementation and engineering teams to preconfigure and map the data. Sending data via the API before the configuration and mapping are already in place will result in errors. Once the configurations are set up, we will notify your team that you can begin sending data.
\n","_postman_id":"7e48a6c8-b5b3-4108-a2af-e4c19324fb12"}],"event":[{"listen":"prerequest","script":{"id":"8faa93e4-f57b-4d20-9831-d83d303cb15c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"28d89b56-04c7-4189-9e1c-ba41a6f6c69e","type":"text/javascript","exec":[""]}}],"variable":[{"id":"1e6da11b-86c1-4d6f-8334-456a2f822979","key":"subdomain","value":"subdomain"}]}