![](\"https://synthetix.com/wp-content/uploads/2021/01/logo_synthetix.png\"){kind=logo}
\n\nWelcome to the Synthetix API documentation. Synthetix is a leading provider of SaaS Business to Business customer service software. Our platform offers a complete online customer service solution, combining automated and agent-assisted Customer Experience (CX) channels to revolutionize the way businesses interact with their customers.
\nOur API provides developers with the tools to integrate our services into their own applications, allowing for seamless access to our features such as real-time messaging, knowledge base, and chatbot capabilities. This enables businesses to boost their customer service efficiency by up to 20%, delivering a superior customer experience.
\nWhether you're looking to integrate our services into your existing systems, develop new applications, or simply explore the possibilities of our platform, this documentation will guide you through the process. It includes detailed explanations of our endpoints, example requests and responses, and troubleshooting tips.
\nWe're committed to helping you make the most of our API, and we're always here to help if you have any questions or run into any issues. Let's get started!
\nThe Synthetix Application Programming Interface (API) is a REST-based platform with predictable, resource-oriented URLs, and uses standard HTTP responses to indicate API errors. We support cross-origin resource sharing, enabling you to interact securely with our API from a client-side web application. All API responses are returned in JSON format.
\nThis document provides comprehensive information about the functionality, standards, and rules of engagement for using the Synthetix API. Please make sure to read and understand this information before you begin integrating with our API.
\nThe following sections provide detailed information about how to start using the Synthetix API, including acquiring and using API keys, setting up and managing service accounts, and other important procedures.
\nAPI keys, designated as APPLICATIONKEY and CONSUMERKEY, are essential for authentication and resource access. These keys are accessible solely to registered and authorised businesses and users, and are linked to a default view of your knowledge base and product assortment.
Application Key (APPLICATIONKEY): This key serves as the identifier for the application making the request to the Synthetix API. It is crucial for tracking and managing the interactions between your application and Synthetix’s resources. The APPLICATIONKEY is unique to each application and helps ensure that the requests are routed correctly and that the application adheres to the permissions and limitations set forth by Synthetix.
Consumer Key (CONSUMERKEY): A consumer, in this context, is a client of Synthetix. The CONSUMERKEY is tied to the consumer and identifies the consumer to Synthetix when requests are made. This key helps Synthetix to verify the identity of the consumer and to ensure that the consumer has the necessary permissions to access or modify the resources requested.
It's crucial that each application has its own application key, uniquely configured for its specific purpose. Using keys intended for another application, or reusing keys provided for your Synthetix.cloud application or your website's hosted application, is strictly prohibited.
\nTo obtain a set of API keys, you should contact your Synthetix Account Manager with a written request. This request must include a detailed description of what the application is intended for, as well as a name and a description for your keys, which will be stored against them for easy identification. In addition, you must acknowledge that you agree with the terms of use of the Synthetix API, as outlined in this documentation. Failure to adhere to these terms may result in your keys being banned and may result in your API access being revoked.
\nAPI keys must be included in the HTTP header for authentication when using the API.
\n{\n \"APPLICATIONKEY\": \"your-application-key\",\n \"CONSUMERKEY\": \"your-consumer-key\"\n}\n\nFor any user accounts being used by the API programmatically, it's recommended to use service accounts rather than standard user accounts. This offers a higher level of security and control over API access. For more information on setting up service accounts, please contact your account manager.
\nSynthetix provides various environments for different stages of application development and testing. By default, any application that has not undergone a review will only have access to the Sandbox environment. Once your application passes a review, access to the Production environment will be granted. Below are the details of each environment:
\nURL: https://api.synthetix.com
Description: The Production environment is the live environment that uses real, operational data. This environment should be used for applications that have been fully developed, tested, and reviewed.
\nAccess: Granted following a successful review of the application. This environment should be used with caution as it affects real-world data and user interactions.
\nURL: https://apistaging.synthetix.com
Description: The Staging environment is a close replica of the Production environment, using cloned databases. It is primarily used for final testing before deploying to Production.
\nAccess: This environment is ideal for pre-production testing, allowing developers to validate their application in a setting that closely mirrors the actual Production environment.
\nURL: https://apisandbox.synthetix.com
Description: The Sandbox environment is a safe and isolated environment for development and penetration testing. It uses cloned databases and is completely separate from the Production environment.
\nAccess: Automatically available to all applications. This environment is recommended for initial development, testing, and ongoing experimentation. It provides a risk-free setting to try new features or conduct security tests.
\nInitial Development: Start with the Sandbox environment to develop and test your application.
\nTesting and Validation: Move to the Staging environment for final testing once your application is stable and ready for a pre-production review.
\nProduction Deployment: After successful review and testing, use the Production environment for your live application.
\nStart in Sandbox
\nUse the Sandbox environment (https://apisandbox.synthetix.com) to build and test your application.
Focus on functionality and handling API responses.
\nTest in Staging
\nOnce your application is stable, move to the Staging environment (https://apistaging.synthetix.com).
Perform final testing in an environment that mirrors Production.
\nSubmit for Review
\nSubmit your application to Synthetix for review.
\nAddress any feedback provided.
\nDeploy to Production
\nAfter approval, switch your application to use the Production environment (https://api.synthetix.com).
Monitor the application for any issues.
\nRemember to handle each environment with the appropriate level of caution and consideration, especially when dealing with real user data in the Production environment. Regularly review and update your application's access to ensure compliance with Synthetix's security standards and best practices.
\nTo ensure the proper integration and usage of the Synthetix API, we have implemented an application review process. This process involves a code review conducted by a Synthetix developer, aimed at evaluating the functionality, logic, and adherence to best practices within your application. Please follow the steps below to initiate the application review:
\nContact your Account Manager: Reach out to your Synthetix Account Manager to express your interest in scheduling an application review. They will guide you through the process and provide further instructions.
\nPurpose Overview: During the review, provide an overview of your application's purpose. Explain its intended functionality, the target audience, and how it will interact with the Synthetix API. This will help the developer gain a comprehensive understanding of your application's objectives.
\nDemonstration of API Usage: Prepare a demonstration of how your application interacts with the Synthetix API. You can present your source code or pseudo code, highlighting the key integration points. Walk through the code and explain the logic and data flow related to Synthetix API access. This demonstration will assist the developer in assessing the implementation and identifying any areas for improvement.
\nExamination of Logic: The Synthetix developer will carefully examine and analyze the sections of your code where interactions with the Synthetix API occur. They will assess the adherence to best practices, efficiency, error handling, and security measures. Be prepared to discuss the decision-making process and rationale behind the integration logic.
\nLive Network Requests: During the review, the developer may request to observe live network requests made by your application to Synthetix servers. This allows them to verify the data exchange, identify any potential issues or performance bottlenecks, and offer suggestions for optimization.
\n\n\nImportant: To ensure a controlled environment and maintain the stability and security of our production environment, it is crucial to perform all development and testing exclusively on the Sandbox environment. Only after your application has been thoroughly reviewed, approved, and signed off by the Synthetix developer, should it be used in our production environment to handle live production-level traffic.
\n
By following this application review process, we can ensure that your application integrates smoothly with the Synthetix API, meets our quality standards, and provides a reliable experience for your users.
\nTo maintain the security and efficiency of our API services, Synthetix implements a policy for the management of unused API keys. This policy outlines the procedures for deactivating and potentially deleting API keys that remain inactive for an extended period.
\nThis policy applies to all API keys issued by Synthetix and is intended to prevent security vulnerabilities and optimize system performance.
\nMonitoring and Identification: Synthetix monitors the activity of all issued API keys. API keys that have not been used for more than 90 days are identified as inactive.
\nTemporary Deactivation: Inactive API keys are automatically disabled. Business and Key owners and will be notified and given instructions on how to request reactivation.
\nRequest Process: Users whose API keys have been deactivated can request reactivation by submitting a support ticket under the category \"API & Applications\". The subject of the ticket should be \"Reverse auto key disable\" followed by the API key in question.
\nAssessment and Reactivation: The support team will assess the reactivation request. If approved, the API key will be reactivated.
\nDeletion Warning: Key holders will receive a final notice if their API key remains inactive and unreactivated by the specified deadline.
\nPermanent Deletion: If no action is taken by the deadline, the API key and any associated application data will be permanently deleted from our systems.
\nThis process is conducted in compliance with our data security protocols and privacy standards, ensuring the protection and integrity of user data and system resources.
\nWhile it is not mandatory to whitelist IPs, it is highly recommended as a crucial security measure. Whitelisting allows you to specify which IP addresses, IP ranges, or fully qualified domain names (FQDNs) are permitted to access your API keys. By implementing whitelisting, you can control and restrict access to your API, enhancing security and protecting your sensitive data.
\nThere are two approaches to configuring whitelisting:
\nSpecific IP Addresses or Domains:
You can provide a list of specific IP addresses or FQDNs that are authorized to access your API keys. To set up this type of whitelisting, please raise a support ticket and include the complete list of additonal allowed IPs or domains. Once added to the whitelist, only the specified IPs or domains will have access, while all others will be automatically blocked.
Wildcard (*) Whitelisting (Caution advised):
As an alternative, you have the option to use a wildcard (*) to allow anyone with the application and consumer key unrestricted access to your API. However, this approach poses potential security risks and should be used with extreme caution. If you decide to proceed with wildcard whitelisting, kindly document the rationale behind it when raising the support ticket, and we will implement it accordingly.
It's important to note that when configuring whitelisting, you can also include IP ranges (CIDR notation) for added flexibility. For example, you can whitelist an entire range of IP addresses like 192.168.1.1/32.
\nPlease ensure that all relevant IP addresses and domains your application may use are included in the whitelist. Any changes made to the whitelist may take upto an hour to propagate and take effect.
\nIn the event of a security breach or suspected unauthorized access, it is crucial to act promptly. Immediately rotate your API keys and update the whitelist accordingly. Additionally, notify your account manager as soon as possible in such cases. They can provide guidance, investigate the situation, and assist you in mitigating potential risks or damages.
\nIf you have any questions or concerns about setting up IP or domain whitelisting, please don't hesitate to contact support. We are dedicated to helping you ensure that your API usage remains secure.
\nTo access and authenticate API requests, we use an Authorization header with a bearer token. The bearer token is a temporary token generated from the profile or session endpoints, and it must be used in conjunction with the application and consumer keys. Please note that we do not utilize OAuth for authentication.
\nTo obtain a bearer token, you need to make a request to the profile or session endpoints using your application and consumer keys. This request will authenticate and authorize your session, generating a temporary bearer token that grants access to the API for that specific session.
\nIt's important to note that bearer tokens are temporary and specific to each session. They provide a level of security and control by limiting the access and lifespan of each token.
\nOnce you have obtained a bearer token, you need to include it in the Authorization header of your API requests. The header should follow the format:
\nAuthorization: {{vault:bearer-token}}
Replace SAMPLE_TOKEN with the actual bearer token generated for your session.
Bearer tokens are sensitive information and should be handled securely. Treat bearer tokens with the same level of confidentiality and protection as you would with any other sensitive credential. It's essential to keep bearer tokens secure and avoid exposing them to unauthorized individuals or publicly accessible locations.
\nDo not include bearer tokens in URLs, query parameters, or other easily accessible locations, as they can be intercepted or compromised. Always use the Authorization header to transmit bearer tokens securely.
\nTo ensure the security and integrity of our API, all API requests must include a User-Agent header. We have rules configured on our Web Application Firewall (WAF) that will automatically ban requests lacking a User-Agent string.
The User-Agent header serves several purposes related to security and protection:
Identification: The User-Agent string helps us identify the nature of the requests, whether they are coming from a web browser, a mobile application, or another type of client.
Security Measures: The User-Agent string allows us to implement advanced security rules and measures. For instance, we may restrict certain types of clients or versions from accessing our API based on the User-Agent.
Protection Against Abuse: Automated bots and malicious actors often omit the User-Agent string to disguise their requests. By requiring a User-Agent, we add an extra layer of security that can filter out potentially harmful activity.
When making an API request, include the User-Agent header like so:
User-Agent: YourAppName/1.0 \n\nReplace YourAppName/1.0 with a string that appropriately identifies your application and its version.
Failure to include a User-Agent header may result in your request being automatically banned by our WAF, so it's crucial that you implement this in all your API requests.
If you have any questions or require further clarification about the User-Agent header requirement, please don't hesitate to contact our support team. We are committed to ensuring that your experience with our API is both secure and efficient.
Bearer tokens have a limited lifespan and are valid only for the duration of the session for which they were generated. The session lengths for different types of sessions are as follows:
\nExternal Session Length: 2 hours
\nInternal Session Length (Generic): 1 hour
\nInternal Session Length (Metrics): 6 hours
\nOnce a session expires, the bearer token becomes invalid, and you will need to obtain a new token by re-authenticating with the profile or session endpoints.
\nIt's important to manage and track session expiry to ensure uninterrupted access to the API. You may need to implement mechanisms to handle session renewal or prompt users to re-authenticate when their session expires.
\nBy using bearer tokens in the Authorization header and following the guidelines mentioned above, you can securely authenticate your API requests and ensure controlled access to the API resources within the context of each session.
\nLong-lived access tokens are sessions that do not expire. They’re an alternative to our standard sessions, which expire after a set duration. They are available on request as a paid add-on.
\nWith a long-lived access token, you do not need to refresh or request new tokens when a normal session expires. This can simplify your integration and reduce authentication overhead in long-running jobs, backend services, or high-throughput workflows. Optionally, you are able to set an expiration with a variety of options from 1 hour to no expiration.
\nKey benefits:
\nNo expiry/custom expiry: Unlike standard sessions, long-lived access tokens remain valid until you revoke them or they expire when the optional expiration is met.
\nFewer auth calls: Eliminates periodic token refresh logic and reduces failed calls due to token expiry.
\nSame access: Permissions and rate limits are the same as your account/configuration allows.
\nGood fit for:
\nAlways-on backend services
\nBatch processing and scheduled jobs
\nSystems where token rotation is operationally costly
\n\n\nNote: Not ideal for short-lived applications or environments where frequent rotation is required by your internal policy.
\n
If you have any questions about these tokens, please speak to your Synthetix account manager.
\nIf you wish to learn more about setting up or managing long-lived tokens, please visit this link for more information: https://help.synthetix.com/article/qed791084/managing-longlived-access-tokens/0/ralJYa6lTmn7qQ==
\nTo ensure the stability and performance of our API, we have implemented rate limiting based on our Web Application Firewall (WAF). The rate limiting is applied to the aggregation of requests originating from a specific source IP address. This means that the total number of requests from a single IP address is limited within a specific timeframe.
\nRate limit: 5,000 requests
\nTimeframe: 5 minutes
\nThe rate limit signifies the maximum number of requests allowed from a single source IP address within a five-minute timeframe. Once the rate limit is reached, further requests from that IP address will be temporarily delayed or denied until the rate limit resets.
\nOur rate limiting mechanism considers all requests originating from a specific IP address. This includes requests made to any endpoint or resource within the API. Therefore, it's important to ensure that your application adheres to the rate limit to prevent disruptions in API access.
\nPlease note that rate limiting is implemented to maintain the stability and fair usage of our API resources. If you find that your application consistently exceeds the rate limit, we recommend optimizing your API usage or contacting our support team to discuss potential solutions.
\n\n\nNote: The rate limit values mentioned above are subject to change. We will notify you in case of any adjustments to the rate limiting thresholds.
\n
Webhooks are a powerful feature that enables your application to receive real-time notifications and take action when specific event codes are triggered within the Synthetix system. They provide a simple way to connect your application with the API and react to events as they occur, rather than continuously polling for updates.
\n\n\nNote: Please note that this section is incomplete, and more event codes will be added in the future.
\n
The following table lists the currently available event codes, their descriptions, and potential use cases:
\nTo effectively use webhooks in your application, you'll need to configure them according to your specific requirements and ensure that your application listens for the specified events. This will enable your application to respond to these events in real-time, enhancing overall system efficiency and user experience.
\nIdentify the event codes your application needs to respond to, as listed in the table above.
\nImplement a listener within your application to handle incoming webhook notifications. This listener should be an endpoint that can process incoming HTTP requests, typically a POST request containing the event data.
\nLiase with your account manager to setup the webhooks, specifying the event codes you want to receive notifications for and the URL of your listener endpoint.
\nTest the webhook integration by triggering the corresponding events in the Synthetix system and confirming that your application receives the notifications and processes them correctly.
\nWhen your listener receives a webhook notification, it should process the event data and take the appropriate action based on the event code. For example, if the event code is 605 (New live chat requested), your application might fetch additional data from a third-party system and display it to the agent handling the chat.
\nIt is essential to implement appropriate error handling and logging mechanisms within your listener, as the webhook notifications may occasionally encounter issues such as network errors, timeouts, or malformed data.
\nTo ensure the security and integrity of your webhook integration, you should take the following precautions:
\nUse HTTPS for your listener endpoint to encrypt the data transmitted between the Synthetix system and your application.
\nValidate the incoming requests to confirm they originate from the Synthetix system. You can do this by checking the request headers, or implementing a shared secret for authentication.
\nLimit the scope of the API keys used for webhook integration to minimize potential damage if the keys are compromised.
\nAdditionally, Synthetix offers a static IP service for an enhanced layer of security. When enabled, all webhooks will originate from a dedicated IP address, allowing you to whitelist this IP address in your firewall or security settings. This feature ensures that only traffic from the Synthetix system can reach your endpoint, further safeguarding your integration. Please note that this is a premium feature and comes at an additional cost. It can be enabled in the add-ons section of your account or by speaking to your account manager.
\nBy incorporating webhooks into your application, you can create a more responsive, efficient, and user-friendly system that seamlessly integrates with the Synthetix API.
\nVariables in webhooks provide a dynamic way to personalize and automate responses based on specific user data and system information. They act as placeholders that are replaced with actual values when the webhook is triggered. Below is a list of default placeholders and their descriptions:
\n{{INPUT}} - Represents all user input.
{{OUTPUT}} - Contains all output from the API.
{{SALUTATION}} - Generates a greeting based on the current time (e.g., 'Morning', 'Afternoon', 'Evening').
{{EMAIL}} - The user's email address.
{{nickname}} - The user's nickname.
{{firstname}} - The user's first name.
{{NAME}} - The user's full name.
{{USERNAME}} - The user's username.
{{USERID}} - The user's ID.
{{UNIQREF}} - A unique reference for the queue entity.
{{ CONSUMERKEY}} - A specific key associated with the consumer.
{{ APPLICATIONKEY}} - A key associated with the application.
{{SESSION}} - The current session identifier.
{{YEAR}}, {{MONTH}}, {{DAY}} - Current year, month, and day, respectively.
{{DATE}} - The current date.
{{ISO8601}} - The current date and time in ISO 8601 format.
{{TIME12}} - The current time in 12-hour format.
{{TIME24}} - The current time in 24-hour format.
{{TIMESTAMP}} - A timestamp of the current moment.
These variables can be used within your webhook payload to tailor the response based on the context of the event and the user involved. For example, you can use {{NAME}} in a message template to automatically insert the user's name.
This policy governs the conduct of penetration testing within Synthetix systems. Penetration testing is an essential practice intended to identify and resolve security vulnerabilities. This policy is designed to ensure that all penetration testing activities are performed safely, legally, and without disrupting the operational integrity of Synthetix systems.
\nImportant Note: All penetration testing activities must be confined exclusively to the designated sandbox environment. Engaging in testing activities outside of this specified environment is strictly prohibited and will be considered a malicious attack against Synthetix systems. Violations of this policy may result in financial penalties and further legal action. Please ensure that all penetration testing is conducted responsibly and in accordance with this policy to avoid any unintended liabilities.
\nTo conduct penetration testing, the following steps must be followed:
\nRequest Access: File a request through our support system including:
\nObjective of the test
\nScope of the test
\nTesting methods
\nStart and end dates
\nIP addresses used for testing
\nTesting tools and software
\nPersonnel involved
\nData handling procedures
\nCommunication plan
\nApproval: Await confirmation and access credentials from the Synthetix security team.
\nCredentials Access:
\nAgent Side URL: https://pentest_sandbox.synthetix.cloud/sandbox/
\nCustomer Side URL: https://cdn.synthetix.com/synthetixjs/sandbox/pentest/index.html?synthetix=/home
\nUsername, Password, and MFA Secret/QR are provided upon request approval.
\nDuring penetration testing, the following actions are prohibited:
\nLoad Testing: No tests that degrade performance or availability.
\nBrute Forcing: No brute force attacks on authentication mechanisms.
\nPhysical Security Testing: No testing involving physical security or personnel interaction.
\nOut-of-Scope Attacks: Do not target systems or assets outside the agreed scope.
\nThird-Party Services and Integrations: Do not test third-party services unless explicitly included in the scope.
\nModification or Deletion of Data: Do not alter or delete data within the sandbox.
\nUse of High-Risk Exploits: Avoid exploits that could cause harm or irreversible changes.
\nSocial Engineering: No testing involving deception of Synthetix employees or partners.
\nAutomated Scanning: Automated tools must be configured to avoid excessive load.
\nPost-testing, submit a detailed report to the Synthetix security team including:
\nAn executive summary of findings
\nDetailed descriptions of vulnerabilities
\nMitigation recommendations
\nRaw outputs and proofs-of-concept
\nTesters must adhere to all legal requirements and conduct testing ethically and professionally. This includes respecting the privacy and security of all data and systems.
\nFor questions or to submit testing results, contact our support team through the official ticket system and update your original ticket if applicable.
\nIf you need to download a large number of live chat transcripts from the Synthetix platform in bulk, you can follow this flow to achieve that:
\nEstablish an HTTP client to communicate with the Synthetix API.
\nImplement the login functionality by sending a POST request to the login endpoint (https://api{environment}.synthetix.com/2.0/internal/session) with the necessary headers and form data (username and password ).
Upon successful login, retrieve the bearer token from the response.
\nUse the obtained bearer token and required headers (APPLICATIONKEY and CONSUMERKEY) to authenticate subsequent API requests.
Send a GET request to the chat IDs endpoint (https://api{environment}.synthetix.com/2.0/internal/chatids) with the desired parameters, such as start and end dates, to fetch the chat IDs.
Process the response to obtain the list of chat IDs.
\nInitialize a loop to iterate over each chat ID retrieved in step 6.
\nFor each chat ID, send a POST request to the details endpoint (https://api{environment}.synthetix.com/2.0/livechat/details) with the chat ID in the request payload to retrieve the chat details.
Handle the response and save the chat details, such as the JSON response or the text content, to the desired location, such as a local file or a database.
\nRepeat the loop for each chat ID until all transcripts have been downloaded.
\nSome general rules:
\nYour script should open a session first, obtain a list of all the required Chat IDs over your selected date range and then obtain transcripts for each of the chat IDs. There is no need to call Profile or Chatids for each call to Details – just open one session for all calls with Profile and make just one call to Chatids to obtain the list, following by multiple calls to Details.
\nOnce you have written your script, please arrange a quick walkthrough with the Synthetix development team to approve your application for use. This will take the form of a short screenshare of your code, describing its function.
\nAs your script will do hundreds of thousands of calls to the Details API, which performs quite a few database queries, we would ask you run it after 9pm and to query no more than one month's worth of data in a session. The session duration is 6 hours. Response time for the Details API can be up to 2.5 seconds and rate limiting will prevent you from submitting more than 10 simultaneous requests, therefore it should be possible to obtain up to 14,400 transcripts per hour. If you submit more than 10 simultaneous requests, an error code (158) will be returned by the request.
\nBy following this flow and understanding the underlying logic, you can customize and build your own application to interact with the Synthetix API and implement specific functionalities based on your requirements.
\nPlease note that the provided logic serves as a reference implementation, and you should adapt it to suit your specific use case and application architecture.
\n\n\nTo see an unofficial application that uses this use case as an example, you can check out the Unofficial Synthetix Transcript Downloader on GitHub at https://github.com/HairyDuck/Synthetix-Transcript-Downloader.
\n
https://addons.mozilla.org/en-GB/firefox/addon/synthetix-transcript-download/
https://chromewebstore.google.com/detail/ndcacfbnjlggoolaginndlpdmkpomjba
To display knowledge articles from the Synthetix platform on your website or app for external users, you can follow this flow:
\nYou need a session token to access the Synthetix API. When you launch your application, you should verify that your stored session token is still valid. If it is no longer valid, or you have no previously stored session token, you need to initialise a new session.
\nSend a POST request to https://api{environment}.synthetix.com/2.0/external/session. Your request header needs to include your APPLICATIONKEY and your CONSUMERKEY. If your api keys are valid, the response will include a new session token.
Send a GET request to https://api{environment}.synthetix.com/2.0/external/session. Your request header needs to include your APPLICATIONKEY and your CONSUMERKEY. As Authorization, you need to use your existing session token as a Bearer Token. If your session token has expired, an error will be thrown.
All subsequent API calls will need to include the following request headers and Authorization:
\n{\n \"headers\": {\n \"APPLICATIONKEY\": \"{your application key}\",\n \"CONSUMERKEY\": \"{your consumer key}\",\n \"Authorization\": \"{{vault:bearer-token}}\"\n }\n}\n\nYou can get a list of the most popular FAQs by sending a GET request to https://api{environment}.synthetix.com/2.0/external/all_faqs with the query parameter ?pop=true. If pop is set to false, you will receive a list of FAQs that are not sorted by popularity. Other params include limitno to set a limit to the amount of FAQs returned, and limitdate to set a date range. Refer to the official Synthetix API documentation for a list of all possible parameters and their use cases, as well as up-to-date response formats.
To search for specific articles based on a search query, send a POST request to https://api{environment}.synthetix.com/2.0/external/search. The following body is required
{\n \"body\": {\n \"query\": \"{Your search query}\",\n \"channel\": 14, //{use channel 14 to search Knowledgebase}\n \"userid\": 1234 //{neccessary in external searches such as this}\n }\n}\n\nFor optional body parameters and their use cases, as well as up-to-date response formats, refer to the official Synthetix API documentation.
\nTo access individual articles, you will need the corresponding article label.
\nSend a POST request to https://api{environment}.synthetix.com/2.0/external/article. The following body is required:
{\n \"body\": {\n \"label\": \"qedXXXXXX\",\n \"channel\": 14,\n \"userid\": \"XXXXXX\"\n }\n}\n\nFor optional body parameters and their use cases, as well as up-to-date response formats, refer to the official Synthetix API documentation.
\nYou can collect feedback for each article. Each feedback question and answer cobination is represented by a unique ID that will be logged. A common feedback question is \"Did this answer your question?\" with answer options being a thumb up or a thumb down. Additional feedback text can also be captured.
\nSend a POST request to https://api{environment}.synthetix.com/2.0/external/article_feedback. In the request body, you need to send the label fo the corresponding article, the feedback question/answer combo id via the feedback param, and, optionally, the additionally captured feedback text.
{\n \"body\": {\n \"label\": \"qedXXXXXX\",\n \"feedback\": 3246,\n \"text\": \"Great article\"\n }\n}\n\nOn successfull feedback, the response returns {\"success\": true}
Please note that the provided logic serves as a reference implementation, and you should adapt it to suit your specific use case and application architecture.
\n\n\nTo see an unofficial application that uses this use case as an example, you can check out the synthetix-knowledge-app by Judith De Muijnck on GitHub at https://github.com/judithdemuijnck/synthetix-knowledge-app.
\n
Add Ons are optional components that extend Synthetix functionality. They let you enhance your platform by enabling third-party integrations and custom modules—without modifying your core configuration.
\nExtend capabilities by adding new features or workflows
\nIntegrate with external tools such as analytics, storage, messaging, or identity providers
\nEnable custom modules built for your organisation’s needs.
\nAdd Ons are installed and configured from within Synthetix. Once enabled, they operate alongside your existing setup and can be managed independently from the base product.
\nFrom the Add Ons section you can:
\nBrowse available Add Ons and view descriptions and requirements
\nInstall and configure selected Add Ons
\nEnable, disable, or uninstall Add Ons as needed
\nReview installed Add Ons to understand what’s active on your platform.
\nSome Add Ons may require additional configuration (for example API keys, access permissions, or external accounts) before they become fully operational.
\nFollow these instructions to add the Synthetix script to your website. Adhering to these guidelines is crucial for ensuring proper functionality and avoiding potential issues.
\nInclude the following script in your HTML:
\n<script src=\"https://cdn.synthetix.com/penfield/get_synthetix.min.js?applicationkey=your-application-key&consumerkey=your-consumer-key\"></script>\n\nEnsure that the Synthetix script is the last script included in your HTML or . This is important to prevent conflicts with other scripts and ensure all necessary resources are loaded before the Synthetix script executes.
\n<html lang=\"en\">\n<head>\n <meta charset=\"UTF-8\">\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\n <title>Your Website</title>\n # Other script and link tags\n <script src=\"https://cdn.synthetix.com/penfield/get_synthetix.min.js?applicationkey=your-application-key&consumerkey=your-consumer-key\"></script>\n</head>\n<body>\n # Your content\n</body>\n</html>\n\nOR:
\n<html lang=\"en\">\n<head>\n <meta charset=\"UTF-8\">\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\n <title>Your Website</title>\n</head>\n<body>\n # Your content\n # Other script and link tags\n <script src=\"https://cdn.synthetix.com/penfield/get_synthetix.min.js?applicationkey=your-application-key&consumerkey=your-consumer-key\"></script>\n</body>\n</html>\n\nDo not dynamically add the Synthetix script using JavaScript. This can lead to issues with script execution order and dependencies.
\n// Avoid this approach\nvar script = document.createElement('script');\nscript.src = \"https://cdn.synthetix.com/penfield/get_synthetix.min.js?applicationkey=your-application-key&consumerkey=your-consumer-key\";\ndocument.head.appendChild(script);\n\nDo not manually invoke any Synthetix functions. Incorrect implementation of function calls or error handling can cause unexpected behaviour and disrupt your website's functionality. Allow the script to manage its own function calls.
\n// Avoid manual function calls like this\nsynthetix.someFunction();\n\nInclude the Synthetix script as the last script in your HTML to prevent conflicts.
\nAvoid dynamically adding the Synthetix script using JavaScript.
\nDo not manually call any functions from the Synthetix library to prevent errors and ensure proper handling by the library itself.
\nBy following these guidelines, you can seamlessly integrate the Synthetix script into your website, ensuring smooth and reliable performance.
\nInstructions coming soon.
\nThe different modalities of potential contact are designated 'channels'. In most cases channel codes are not required, but for the avoidance of doubt channel codes are as found below.
\nOur API uses standard HTTP status codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, a charge failed, etc.), and codes in the 5xx range indicate an error with our servers.
\nHere are some of the most common status codes you'll encounter:
\n200 OK: The request was successful.
\n201 Created: The request was successful, and a resource was created as a result.
\n204 No Content: The request was successful, but there's no representation to return (i.e. the response is empty).
\n400 Bad Request: The request could not be understood or was missing required parameters.
\n401 Unauthorized: Authentication failed or was not provided.
\n403 Forbidden: Authentication succeeded, but the authenticated user does not have access to the requested resource.
\n404 Not Found: The requested resource could not be found.
\n405 Method Not Allowed: The HTTP method used is not supported for the requested resource.
\n406 Not Acceptable: The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.
\n426 Upgrade Required: The client should switch to a different protocol such as TLS/1.0.
\n429 Too Many Requests: The user has sent too many requests in a given amount of time (\"rate limiting\").
\n500 Internal Server Error: An error occurred with our servers. Please try again later or raise a support request
\n503 Service Unavailable: The server is currently unavailable (because it is overloaded or down for maintenance). Generally, this is a temporary state.
\nIf an error occurs, the API will return an error object. This object will include a code (an internal error code unique to the error), a message (a human-readable message explaining the error), and a field (the field in the request that caused the error, if applicable).
(Expand to view the full list).
\nAt Synthetix, we strive to provide comprehensive resources to assist you in implementing our APIs effectively. Our documentation is designed to guide you through integration and troubleshooting common issues independently.
\nWe do not generally offer one-to-one support for API implementation. Users are encouraged to utilize our extensive documentation for guidance and best practices in implementing our APIs.
\nIf you encounter a genuine issue with the API that goes beyond a typical implementation error, we are here to help:
\nAccess the Portal: Visit your Synthetix.cloud portal and log in with your credentials or visit the support portal https://support.synthetix.com
\nCreate a New Ticket: Select the option to create a new ticket and categorize it as an API & Applications.
\nProvide Details: Fill in the details of your issue, including steps to reproduce the problem, the impact it has on your operations, and any troubleshooting steps you have already attempted.
\nSubmit the Ticket: Once completed, submit the ticket. Our support team will review your submission and get back to you as soon as possible.
\nPlease note that our response time may vary depending on the complexity of the issue and current ticket volume. We prioritize issues based on their severity and impact.
\nWhile our API provides powerful functionality, there are certain restrictions and limitations in place to ensure the overall performance, security, and fair usage of our services. It's important to be aware of these restrictions to effectively integrate and utilize our API. The following are the key restrictions and limitations to consider:
\nAs mentioned in the Rate Limiting section, our API implements rate limiting to prevent abuse and ensure fair usage of resources. The rate limit defines the maximum number of requests allowed within a specific timeframe. Exceeding the rate limit will result in temporary delays or denials of further requests until the rate limit resets. Please refer to the Rate Limiting section for specific details on rate limit values and implementation.
\nTo access our API, you are required to authenticate using valid credentials, such as API keys or tokens. It's essential to keep your authentication credentials secure and confidential. Additionally, access controls may be enforced to limit certain operations or data based on user roles or permissions. Make sure to follow the authentication guidelines provided in our API documentation to ensure proper access and data protection.
\nWhen using our API, you must adhere to relevant data usage and privacy regulations. Ensure that you have appropriate legal rights and permissions to access and process any data provided through the API. It's your responsibility to handle user data in compliance with applicable privacy laws and protect the confidentiality and integrity of user information.
\nOur API has an acceptable use policy that defines the terms and conditions for utilizing our services. You must comply with this policy, which may include restrictions on prohibited activities, content, or usage patterns. Violations of the acceptable use policy may result in temporary or permanent suspension of API access privileges.
\nWhile we strive to provide a reliable and high-performance API service, certain factors beyond our control may impact service availability or performance. It's important to review our Service Level Agreement (SLA) in your contract, if applicable, which outlines the guaranteed uptime, response times, and support commitments. The SLA will specify any compensation or remedies available in case of service disruptions or performance degradation.
\nPlease note that the restrictions and limitations mentioned above are subject to change. We may update these restrictions from time to time to improve our services or address security concerns. It's recommended to stay updated with our API documentation and any communications from us to ensure compliance with the latest restrictions and limitations.
\nBy understanding and adhering to these restrictions and limitations, you can effectively utilize our API while ensuring the stability, security, and fair usage of our services.
\nThese Terms of Service (\"Terms\") govern your access to and use of the Synthetix API (\"API\") provided by Synthetix Ltd. (\"Synthetix\", \"we\", \"us\" or \"our\"), a company registered in the United Kingdom. By accessing or using the API, you (\"Client\", \"you\", or \"your\") agree to be bound by these Terms.
\nAccess and Use
\nAccess to the API is granted to Synthetix clients only.
\nYou may not use the API for any purpose that is unlawful or prohibited by these Terms.
\nYou shall not use the staging environment for production workloads. The staging environment is provided for testing purposes only
\nYou are required to use the sandbox environment for development purposes.
\nCode Review and Production Access
\nBefore gaining access to the production API, you must undergo a code review with a Synthetix developer. The developer will help ensure that your application is properly configured for the production environment.
\nOnce the code review is completed and any necessary changes are made, you will be granted access to the production API.
\nRestrictions
\nYou shall not sublicense, resell, transfer, or otherwise share your API access or API key with any third party.
\nYou shall not use the API to create or promote any service that is competitive with Synthetix or any of its products or services.
\nYou shall not use the API in any manner that could damage, disable, overburden, or impair Synthetix's systems or services.
\nOwnership and Intellectual Property
\nAll rights, title, and interest in and to the API, including any and all intellectual property rights, are owned by Synthetix or its licensors.
\nYou acknowledge that the API is provided under license, and not sold, to you. You do not acquire any ownership interest in the API under these Terms.
\nTermination
\nSynthetix may terminate or suspend your access to the API at any time and for any reason, including, but not limited to, your breach of these Terms.
\nUpon termination or suspension, you must immediately cease using the API and delete all copies of the API and related data in your possession or control.
\nAPI Modifications
\nCompliance and API Key Revocation
\nGoverning Law
These Terms shall be governed by and construed in accordance with the laws of the United Kingdom. Any disputes arising out of or in connection with these Terms shall be subject to the exclusive jurisdiction of the courts of the United Kingdom.
Amendments
Synthetix reserves the right to modify these Terms at any time by providing notice on its website or through the API. Your continued use of the API following the posting of any changes to these Terms constitutes your acceptance of those changes.
Contact Information
If you have any questions or concerns regarding these Terms or the API, please contact us at support@synthetix.com.
Compliance with Laws
\nPrivacy
\nFeedback
\nSupport
\nConstants are immutable variables. This endpoint is used to create a new set of environmental constants within the associated session. Each constant is defined using a key-value pair in the request body, where the key represents the name of the new constant and the value represents the value to be assigned to it. Constant values can be either single or multi-dimensional, specified by sending a string or an array respectively.
\nUpon successful creation, the endpoint returns the updated list of environmental constants associated with the session. Note that constants are immutable. Attempting to overwrite an existing constant by sending a key that already exists will not modify the current value. Once a constant is set, it remains unchangeable and cannot be deleted.
\n","urlObject":{"protocol":"https","path":["2.0","environment","constants"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"93061461-ba7a-4411-a276-e0c19c26e049","name":"constants","originalRequest":{"method":"POST","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"firstname\": \"Luke\"}","options":{"raw":{"language":"json"}}},"url":"https://apisandbox.synthetix.com/2.0/environment/constants"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,POST,DELETE,PATCH,PUT,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Date","value":"Wed, 24 Oct 2018 11:38:39 GMT","enabled":true},{"key":"Expires","value":"2018-10-24T15:28:54+00:00","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-API-Node","value":"52c20b7818fd","enabled":true},{"key":"X-API-Version","value":"development;(D3)","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Quota","value":"unlimited/infinite","enabled":true},{"key":"X-Request-ID","value":"1540381119-1705117003-219","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Content-Length","value":"58","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"firstname\": \"Luke\"\n}"}],"_postman_id":"d741f441-813f-43eb-b07e-202cdea9bda5"},{"name":"variables","id":"a1e4c3ad-b4fd-42cb-808b-b6d1f6da0515","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"url":"https://apisandbox.synthetix.com/2.0/environment/variables","description":"Returns a list of the environmental variables associated to this session.
\n","urlObject":{"protocol":"https","path":["2.0","environment","variables"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"0cca55c0-624b-4f05-9f9d-243796c79a3f","name":"variables","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"url":"https://apisandbox.synthetix.com/2.0/environment/variables"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,POST,DELETE,PATCH,PUT,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Date","value":"Wed, 24 Oct 2018 11:37:26 GMT","enabled":true},{"key":"Expires","value":"2018-10-24T15:28:54+00:00","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-API-Node","value":"52c20b7818fd","enabled":true},{"key":"X-API-Version","value":"development;(D3)","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Quota","value":"unlimited/infinite","enabled":true},{"key":"X-Request-ID","value":"1540381046-1705105573-127","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Content-Length","value":"40","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"firstname\": \"Luke\"\n}"}],"_postman_id":"a1e4c3ad-b4fd-42cb-808b-b6d1f6da0515"},{"name":"variables","id":"97ed6902-7eea-4227-8801-92459b82d2b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n","type":"text"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"your-variable-name","value":"your-variable-value","type":"text"}]},"url":"https://apisandbox.synthetix.com/2.0/environment/variables","description":"This endpoint is used to create a new set of environmental variables within the associated session. The variable is defined using a key-value pair in the request body, where the key represents the name of the new variable and the value represents the value to be assigned to it. Variable values can be either single or multi-dimensional, specified by sending a string or an array respectively.
\nUpon successful creation, the endpoint returns the updated list of environmental variables associated with the session. Note that this will overwrite any existing variables. To update existing variables, use the PATCH method instead.
\n","urlObject":{"protocol":"https","path":["2.0","environment","variables"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"6fce6e6a-6950-4db8-bcf6-e019b426b1ae","name":"variables","originalRequest":{"method":"POST","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"firstname\": \"Luke\"}","options":{"raw":{"language":"json"}}},"url":"https://apisandbox.synthetix.com/2.0/environment/variables"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,POST,DELETE,PATCH,PUT,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Date","value":"Wed, 24 Oct 2018 11:38:39 GMT","enabled":true},{"key":"Expires","value":"2018-10-24T15:28:54+00:00","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-API-Node","value":"52c20b7818fd","enabled":true},{"key":"X-API-Version","value":"development;(D3)","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Quota","value":"unlimited/infinite","enabled":true},{"key":"X-Request-ID","value":"1540381119-1705117003-219","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Content-Length","value":"58","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"firstname\": \"Luke\"\n}"}],"_postman_id":"97ed6902-7eea-4227-8801-92459b82d2b0"},{"name":"variables","id":"f9648866-1090-49ac-8664-52896665ba13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"PATCH","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"your-variable-name1","value":"your-variable-value1","type":"text"},{"key":"your-variable-name2","value":"your-variable-value2","type":"text"}]},"url":"https://apisandbox.synthetix.com/2.0/environment/variables","description":"This endpoint is used to add or update environmental variables within the associated session. The variable is defined using a key-value pair in the request body, where the key represents the name of the variable and the value represents the value to be assigned to it. Variable values can be either single or multi-dimensional, specified by sending a string or an array respectively.
\nIf the specified variable key already exists, its value will be updated to the new value provided in the request body. If the key does not exist, a new variable will be added to the environmental variables associated with that session. Upon successful addition or update, the endpoint returns the updated list of environmental variables associated with the session.
\n","urlObject":{"protocol":"https","path":["2.0","environment","variables"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"0ac52b10-c7dd-4cb2-8e7e-72ad35cd14a2","name":"variables","originalRequest":{"method":"PATCH","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"lastname\": \"Addington\"}"},"url":"https://apisandbox.synthetix.com/2.0/environment/variables"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,POST,DELETE,PATCH,PUT,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Date","value":"Wed, 24 Oct 2018 11:39:01 GMT","enabled":true},{"key":"Expires","value":"2018-10-24T15:28:54+00:00","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-API-Node","value":"52c20b7818fd","enabled":true},{"key":"X-API-Version","value":"development;(D3)","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Quota","value":"unlimited/infinite","enabled":true},{"key":"X-Request-ID","value":"1540381141-1705120234-191","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Content-Length","value":"56","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"firstname\": \"Luke\",\n \"lastname\": \"Addington\"\n}"}],"_postman_id":"f9648866-1090-49ac-8664-52896665ba13"},{"name":"variables","id":"fbff67ae-0f22-45ca-b081-efcd723b0cfa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"PUT","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"your-variable-name","value":"your-new-variable-value","type":"text"}]},"url":"https://apisandbox.synthetix.com/2.0/environment/variables","description":"This endpoint replaces all existing environmental variables within the associated session with the new request payload. All variables will be cleared, and new variables will be set according to the key-value pairs provided in the request body, where the key represents the name of the new variable and the value represents the value to be assigned to it. Variable values can be either single or multi-dimensional, specified by sending a string or an array respectively.
\nUpon successful replacement, the endpoint returns the updated list of environmental variables associated with the session. Note, if no request body is provided, all existing environmental variables will be deleted.
\n","urlObject":{"protocol":"https","path":["2.0","environment","variables"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"03aa3a78-d8ef-4a57-ae4e-951fe5db0ab9","name":"variables","originalRequest":{"method":"PUT","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"firstname\": \"Anakin\"}","options":{"raw":{"language":"json"}}},"url":"https://apisandbox.synthetix.com/2.0/environment/variables"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,POST,DELETE,PATCH,PUT,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Date","value":"Wed, 24 Oct 2018 11:37:26 GMT","enabled":true},{"key":"Expires","value":"2018-10-24T15:28:54+00:00","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-API-Node","value":"52c20b7818fd","enabled":true},{"key":"X-API-Version","value":"development;(D3)","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Quota","value":"unlimited/infinite","enabled":true},{"key":"X-Request-ID","value":"1540381046-1705105573-127","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Content-Length","value":"40","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"firstname\": \"Anakin\"\n}"}],"_postman_id":"fbff67ae-0f22-45ca-b081-efcd723b0cfa"},{"name":"variables","id":"4dfc4849-e036-4e6c-ab45-22a036e08e7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"DELETE","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"body":{"mode":"raw","raw":"{\"delete\": [\"your-variable-name\"]}","options":{"raw":{"language":"json"}}},"url":"https://apisandbox.synthetix.com/2.0/environment/variables","description":"This endpoint removes existing environmental variables within the associated session that match the keys provided in the request body. The request body should include a key-value pair, where the key is \"delete\" and the value is an array containing the keys of existing variables to be deleted.
\nUpon successful deletion, the endpoint returns the updated list of environmental variables associated with the session.
\n","urlObject":{"protocol":"https","path":["2.0","environment","variables"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"b37da31a-caf3-474b-8c1a-d8fe4d3c2e87","name":"variables","originalRequest":{"method":"DELETE","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#getting-started)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#getting-started)"}],"body":{"mode":"raw","raw":"{\"delete\": [\"firstname\"]}","options":{"raw":{"language":"json"}}},"url":"https://apisandbox.synthetix.com/2.0/environment/variables"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 23 Apr 2024 11:27:44 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"62","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,ETag,Last-Modified,Date,HTTP_X_AMZN_TRACE_ID","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=7776000","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"HTTP_X_AMZN_TRACE_ID","value":"Root=1-66279b30-5a49cfe137523acc277d87de","enabled":true},{"key":"X-API-Node","value":"8f631a [Nightly]","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,POST,DELETE,PATCH,PUT,OPTIONS","enabled":true},{"key":"Expires","value":"2024-04-23T17:26:12+00:00","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"lastname\": \"Addington\"\n}"}],"_postman_id":"4dfc4849-e036-4e6c-ab45-22a036e08e7b"}],"id":"7e0a192d-c2ed-45a9-a3b2-accf636c8d51","description":"Environment endpoints empower you to manage environmental variables and constants within the associated session. They allow for the creation, updating, and deletion of variables and constants, providing flexibility and control over the session's environment.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"1f7dd5cf-c231-4cfb-abeb-60923dfeedfc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cb82b1fa-02a2-4eaf-a5fa-b2223fdf5769","type":"text/javascript","exec":[""]}}],"_postman_id":"7e0a192d-c2ed-45a9-a3b2-accf636c8d51"},{"name":"external","item":[{"name":"all_faqs","id":"dd682fbf-af5b-49b8-a3c9-fd075d28866b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"url":"https://apisandbox.synthetix.com/2.0/external/all_faqs?direction=DESC&order_by=last edited&limitno=10","description":"Returns the most popular articles within the knowledge base during a specified timeframe. It automatically restricts access to articles within the allowed views of the application. When accessed from an external application, it excludes views marked as private.
\n","urlObject":{"protocol":"https","path":["2.0","external","all_faqs"],"host":["apisandbox.synthetix.com"],"query":[{"disabled":true,"description":{"content":"Restrict popular articles to single category
\n","type":"text/plain"},"key":"category","value":"My Account"},{"description":{"content":"ASC OR DESC . Defaults to DESC.
Number of days over which to collate data. Defaults to 7.
\n","type":"text/plain"},"key":"limitdate","value":"365"},{"disabled":true,"description":{"content":"true OR false. Defaults to false. Governs whether popular articles are returned in order of popularity
Restrict popular articles to single subcategory
\n","type":"text/plain"},"key":"subcategory","value":"Logging in"},{"description":{"content":"last edited OR comments OR timestamp. Defaults to last edited.
mandatory if external
mandatory
true or false. Returns comments in response. Defaults to false
for logging purposes
\n"},{"key":"origin_url","value":"http://www.synthetix.com","type":"text"},{"key":"channel","value":"14","description":"mandatory Learn more about channels...
true or false. Returns previous version of the article. Defaults to false
trueor false. Toggles logging on or off. Defaults to true
Retrieves the data of a knowledge article. Note that each call made to this endpoint is logged in the Synthetix metrics as a hit or click on that particular article.
\nThe feedback property has been deprecated in favour of the newfeedback property.
\n","urlObject":{"protocol":"https","path":["2.0","external","article"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"2c3ff0f3-9751-4322-8b31-3e7d6e3453bb","name":"article","originalRequest":{"method":"POST","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"userid","value":"123456","description":"`mandatory` if external","type":"text"},{"key":"label","value":"qed00001","description":"`mandatory`","type":"text"},{"key":"comments","value":"true","type":"text","description":"`true` or `false`. Returns comments in response. Defaults to `false`","disabled":true},{"key":"index","value":"8","type":"text","description":"for logging purposes"},{"key":"origin_url","value":"http://www.synthetix.com","type":"text"},{"key":"channel","value":"14","description":"`mandatory` [Learn more about channels...](#channels)","type":"text"},{"key":"revision_history","value":"false","type":"text","description":"`true` or `false`. Returns previous version of the article. Defaults to `false` "},{"key":"origin","value":"qed000999","type":"text"},{"key":"logging","value":"false","description":"`true`or `false`. Toggles logging on or off. Defaults to `true`","type":"text"}]},"url":"https://apisandbox.synthetix.com/2.0/external/article"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 25 Apr 2024 15:29:35 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"877","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,ETag,Last-Modified,Date,HTTP_X_AMZN_TRACE_ID","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=7776000","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"HTTP_X_AMZN_TRACE_ID","value":"Root=1-662a76df-2fa93c500d9497254c82d8d1","enabled":true},{"key":"X-API-Node","value":"8f631a [Nightly]","enabled":true},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS","enabled":true},{"key":"Expires","value":"2024-04-25T21:23:18+00:00","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"allowed views\": {\n \"3159\": {\n \"view\": \"FAQs\",\n \"viewlogging\": \"FAQTAGENT-SYNTHETIX-MASTER\"\n },\n \"3160\": {\n \"view\": \"webforms\",\n \"viewlogging\": \"FAQTAGENT-SYNTHETIX-MASTER\"\n },\n \"3166\": {\n \"view\": \"archive\",\n \"viewlogging\": \"FAQTAGENT-SYNTHETIX-MASTER\"\n },\n \"3224\": {\n \"view\": \"zombie\",\n \"viewlogging\": \"FAQTAGENT-SYNTHETIX-MASTER\"\n },\n \"3311\": {\n \"view\": \"test\",\n \"viewlogging\": \"FAQTAGENT-SYNTHETIX-MASTER\"\n },\n \"3320\": {\n \"view\": \"Internal\",\n \"viewlogging\": \"FAQTAGENT-SYNTHETIX-MASTER\"\n }\n },\n \"allowed view\": true,\n \"public view\": true,\n \"question\": \"Do you do email management?\",\n \"answer\": \"Email Management from Synthetix integrates handling of skill-based email queues into your existing agents workflows, using our multi-channel contact queue. This means that all types of contact (chat, callback requests, emails, etc) are all offered to agents with the correct permissions. For more information about our email management product, please click here.\",\n \"category\": \"Contact Centre Cloud\",\n \"metatags\": \"\",\n \"commands\": [],\n \"decisiontree_owner\": \"\",\n \"actions\": null,\n \"url\": null,\n \"view\": \"FAQs\",\n \"lastediteddate\": \"Tue, 09 Feb 2016 11:17:41 UTC\",\n \"lasteditedauthor\": \"\",\n \"answerid\": \"123456789\",\n \"require_user_confirmation\": \"n\",\n \"user_confirmation_message\": \"\",\n \"feedback\": [\n {\n \"Question\": \"How Did this answer your question?\",\n \"ID\": \"Q1\",\n \"Answers\": [\n \"Yes\",\n \"No\"\n ]\n },\n {\n \"Question\": \"Are you sure?\",\n \"ID\": \"Q2\",\n \"Answers\": [\n \"Yes\",\n \"No\"\n ]\n },\n {\n \"Question\": \"Please let us have any further comments you may have\",\n \"ID\": \"Q5\",\n \"Answers\": [\n null\n ]\n }\n ],\n \"newfeedback\": {\n \"1\": {\n \"How Did this answer your question?\": [\n {\n \"3246\": \"Yes\"\n },\n {\n \"3247\": \"No\"\n }\n ]\n },\n \"2\": {\n \"Are you sure?\": [\n {\n \"3249\": \"Yes\"\n },\n {\n \"3250\": \"No\"\n }\n ]\n },\n \"5\": {\n \"Please let us have any further comments you may have\": [\n {\n \"3253\": null\n }\n ]\n }\n },\n \"subcategories\": {\n \"subcategory_1\": \"Email Management\",\n \"subcategory_2\": null,\n \"subcategory_3\": null\n },\n \"faq_id\": \"1234566789==\",\n \"confirmed\": false,\n \"confirmed_time\": \"\"\n}"}],"_postman_id":"7cb87ae9-2558-4f8e-8397-bf8e1af71f0d"},{"name":"article_feedback","id":"aac6078b-a535-449d-84b1-103beb91b09f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"POST","header":[{"key":"APPLICATIONKEY","value":"your-application-key","type":"text","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","type":"text","description":"\n"}],"body":{"mode":"formdata","formdata":[{"key":"feedback","value":"456","type":"text"},{"key":"text","value":"Great answer","type":"text"},{"key":"label","value":"qed00009","type":"text"}]},"url":"https://apisandbox.synthetix.com/2.0/external/article_feedback","description":"Utilize this endpoint to record feedback regarding a specific article. Each feedback entry corresponds to a unique ID, which must be provided along with the article label and any additional free-text comments. This endpoint logs a single instance of feedback per call.
\nThe feedback property has been deprecated in favour of the newfeedback property.
\n","urlObject":{"protocol":"https","path":["2.0","external","article_feedback"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"b7f1ec8a-526a-4961-bea5-97da0f4c82dc","name":"article_feedback","originalRequest":{"method":"POST","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"body":{"mode":"formdata","formdata":[{"key":"feedback","value":"456","type":"text"},{"key":"text","value":"Great answer","type":"text"},{"key":"label","value":"qed00009","type":"text"},{"key":"","value":"","type":"text","disabled":true}]},"url":"https://apisandbox.synthetix.com/2.0/external/article_feedback"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 25 Apr 2024 15:33:07 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"36","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,ETag,Last-Modified,Date,HTTP_X_AMZN_TRACE_ID","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=7776000","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"HTTP_X_AMZN_TRACE_ID","value":"Root=1-662a77b3-03ec2217415e820664a89b82","enabled":true},{"key":"X-API-Node","value":"8f631a [Nightly]","enabled":true},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS","enabled":true},{"key":"Expires","value":"2024-04-25T21:29:35+00:00","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"aac6078b-a535-449d-84b1-103beb91b09f"},{"name":"breadcrumb","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"token\", jsonData.token);"],"type":"text/javascript","id":"7cb36ac0-3963-436d-a6c7-1ebb5aeda6a4"}}],"id":"ed98611c-2dab-453b-a078-cfaf9b1617c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"url":"https://apisandbox.synthetix.com/2.0/external/breadcrumb","description":"Request details of all interactions to date for the associated session.
\n","urlObject":{"protocol":"https","path":["2.0","external","breadcrumb"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"8e7995a8-00fa-448b-aa7b-4b144d7c6d89","name":"breadcrumb","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"url":"https://apisandbox.synthetix.com/2.0/external/breadcrumb"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Methods","value":"POST,GET,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Date","value":"Fri, 26 Oct 2018 13:59:31 GMT","enabled":true},{"key":"Expires","value":"2018-10-26T14:59:22+00:00","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-API-Node","value":"e4ebdc150baf","enabled":true},{"key":"X-API-Version","value":"development;(D3)","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Quota","value":"unlimited/infinite","enabled":true},{"key":"X-Request-ID","value":"1540562371-1720901828-87","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Content-Length","value":"122","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n {\n \"timestamp\": 1540562356,\n \"time\": \"2018-10-26 14:59:16\",\n \"typeID\": \"ArticleView\",\n \"type\": \"ArticleView\",\n \"value\": \"QED0001\",\n \"detail\": null\n }\n]"}],"_postman_id":"ed98611c-2dab-453b-a078-cfaf9b1617c2"},{"name":"breadcrumb","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"4cfaf0f6-4a3a-4f9a-a1e2-5cc820fd8593"}}],"id":"4421d8e7-a98c-470c-a352-a2c4955c5d27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"POST","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"body":{"mode":"formdata","formdata":[{"key":"type","value":"ArticleView","type":"text"},{"key":"value","value":"QED0001","type":"text"}]},"url":"https://apisandbox.synthetix.com/2.0/external/breadcrumb","description":"Registers an interaction and adds it to the list of session breadcrumbs. Include an interaction type, which serves as the key, along with its corresponding value. Upon successful registration against the session, the endpoint returns 'true'.
\n","urlObject":{"protocol":"https","path":["2.0","external","breadcrumb"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"64002f31-ffd7-4314-88bc-94b65daf6c5f","name":"breadcrumb","originalRequest":{"method":"POST","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"body":{"mode":"formdata","formdata":[{"key":"type","value":"ArticleView","type":"text"},{"key":"value","value":"QED0001","type":"text"}]},"url":"https://apisandbox.synthetix.com/2.0/external/breadcrumb"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Methods","value":"POST,GET,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Date","value":"Fri, 26 Oct 2018 13:59:16 GMT","enabled":true},{"key":"Expires","value":"2018-10-26T14:59:08+00:00","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-API-Node","value":"e4ebdc150baf","enabled":true},{"key":"X-API-Version","value":"development;(D3)","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Quota","value":"unlimited/infinite","enabled":true},{"key":"X-Request-ID","value":"1540562356-1720899387-129","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Content-Length","value":"24","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"4421d8e7-a98c-470c-a352-a2c4955c5d27"},{"name":"categories","id":"458e3ce1-8a4a-490b-8511-387520302f92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"POST","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"hidden","value":"true","description":"Indicates whether hidden categories should be included. Defaults to false`
This endpoint retrieves a map detailing the category and subcategory structure of your knowledge base, including category names and IDs. Restricted automatically to those categories associated with the application's allowed views.
\n","urlObject":{"protocol":"https","path":["2.0","external","categories"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"47f8b61e-11a5-4952-9fcb-93e75d8ed0b3","name":"categories","originalRequest":{"method":"POST","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"body":{"mode":"formdata","formdata":[{"key":"hidden","value":"true","description":"Indicates whether `hidden` categories should be included. Fefaults to false","type":"text"}]},"url":"https://apisandbox.synthetix.com/2.0/external/categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Methods","value":"POST,GET,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Date","value":"Tue, 27 Nov 2018 15:10:07 GMT","enabled":true},{"key":"Expires","value":"2018-11-27T21:05:22+00:00","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-API-Node","value":"0df1b46c168b","enabled":true},{"key":"X-API-Version","value":"staging;(S3)","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Quota","value":"unlimited/infinite","enabled":true},{"key":"X-Request-ID","value":"1543331407-1947768624-193","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Content-Length","value":"387","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 24968,\n \"parent\": 0,\n \"category\": \"About Synthetix\",\n \"order\": 1,\n \"views\": [\n \"3166\",\n \"3159\",\n \"3320\",\n \"3311\",\n \"3160\",\n \"3224\"\n ],\n \"imageurl\": null,\n \"displaytxt\": \"About Synthetix\",\n \"visible\": true,\n \"subcategory\": [\n {\n \"id\": 36373,\n \"parent\": 24968,\n \"category\": \"Locations\",\n \"visible\": \"y\",\n \"subcategory\": []\n }\n ]\n },\n {\n \"id\": 24969,\n \"parent\": 0,\n \"category\": \"Self-service cloud\",\n \"order\": 2,\n \"views\": [\n \"3159\"\n ],\n \"imageurl\": null,\n \"displaytxt\": \"Self-service cloud\",\n \"visible\": true,\n \"subcategory\": [\n {\n \"id\": 34630,\n \"parent\": 24969,\n \"category\": \"FAQ Search\",\n \"visible\": \"y\",\n \"subcategory\": []\n },\n {\n \"id\": 34631,\n \"parent\": 24969,\n \"category\": \"Dynamic web forms\",\n \"visible\": \"y\",\n \"subcategory\": []\n }\n ]\n },\n {\n \"id\": 24970,\n \"parent\": 0,\n \"category\": \"Contact Centre Cloud\",\n \"order\": 3,\n \"views\": [\n \"3159\"\n ],\n \"imageurl\": null,\n \"displaytxt\": \"Contact Centre Cloud\",\n \"visible\": true,\n \"subcategory\": [\n {\n \"id\": 36342,\n \"parent\": 24970,\n \"category\": \"Hints and Tips\",\n \"visible\": \"02\",\n \"subcategory\": []\n },\n {\n \"id\": 34632,\n \"parent\": 24970,\n \"category\": \"Agent knowledge-base\",\n \"visible\": \"y\",\n \"subcategory\": []\n },\n {\n \"id\": 34633,\n \"parent\": 24970,\n \"category\": \"Live Chat\",\n \"visible\": \"y\",\n \"subcategory\": []\n },\n {\n \"id\": 34635,\n \"parent\": 24970,\n \"category\": \"Email Management\",\n \"visible\": \"y\",\n \"subcategory\": []\n }\n ]\n },\n {\n \"id\": 24971,\n \"parent\": 0,\n \"category\": \"webform\",\n \"order\": 4,\n \"views\": [\n \"3160\"\n ],\n \"imageurl\": null,\n \"displaytxt\": null,\n \"visible\": true,\n \"subcategory\": []\n }\n]"}],"_postman_id":"458e3ce1-8a4a-490b-8511-387520302f92"},{"name":"full_faqs","id":"ec6960a1-4e8d-474c-8f75-06c3fe07e6eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"url":"https://apisandbox.synthetix.com/2.0/external/full_faqs?category=My Account&limitdate=20&limitno=99&subcategory=Logging in","description":"This endpoint is used for displaying all articles in a knowledge-base.
\n","urlObject":{"protocol":"https","path":["2.0","external","full_faqs"],"host":["apisandbox.synthetix.com"],"query":[{"description":{"content":"Restrict popular articles to single category
\n","type":"text/plain"},"key":"category","value":"My Account"},{"description":{"content":"Number of days over which to collate data. Defaults to 7.
\n","type":"text/plain"},"key":"limitdate","value":"20"},{"description":{"content":"Number of articles to return. Defaults to 20.
\n","type":"text/plain"},"key":"limitno","value":"99"},{"description":{"content":"Restrict popular articles to single subcategory
\n","type":"text/plain"},"key":"subcategory","value":"Logging in"},{"disabled":true,"description":{"content":"View filter. If passed must match exactly with application allowed view.
\n","type":"text/plain"},"key":"view","value":"public"}],"variable":[]}},"response":[{"id":"aaaf4214-4cef-41ee-8a32-e9407c11edd7","name":"full_faqs","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"url":{"raw":"https://apisandbox.synthetix.com/2.0/external/full_faqs?category=My Account&subcategory=Logging in","protocol":"https","host":["apisandbox","synthetix","com"],"path":["2.0","external","full_faqs"],"query":[{"key":"category","value":"My Account","description":"Restrict popular articles to single category"},{"key":"subcategory","value":"Logging in","description":"Restrict popular articles to single subcategory"},{"key":"view","value":"public","disabled":true}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"label\": \"lbl0111\",\n \"comments\": 1,\n \"question\": \"How do I login?\",\n \"answer\": \"This is an example article about logging in
\",\n \"category\": \"My Account\",\n \"subcategory\": \"Logging in\",\n \"last edited\": \"2024-02-09 15:17:10\",\n \"available_from\": false,\n \"available_to\": false,\n \"timestamp\": 1707491830,\n \"views\": [\n \"FAQs\"\n ]\n },\n {\n \"label\": \"lbl00222\",\n \"comments\": 6,\n \"question\": \"What if I have issues logging in?\",\n \"answer\": \"We apologise for the issues you are facing
\",\n \"category\": \"My Account\",\n \"subcategory\": \"Logging in\",\n \"last edited\": \"2024-01-16 19:13:59\",\n \"available_from\": false,\n \"available_to\": false,\n \"timestamp\": 1705432439,\n \"views\": [\n \"FAQs\"\n ]\n }\n ],\n \"totalresults\": 2\n}"}],"_postman_id":"ec6960a1-4e8d-474c-8f75-06c3fe07e6eb"},{"name":"report","id":"ab6998e3-b340-4c14-8f7d-358a14b09f69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"POST","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"userID","value":"123456","description":"mandatory only if running on external application
Either search OR article are mandatory
Comments
\n","type":"text"},{"key":"type","value":"The search has no answers","description":"Type of issue identified with article
\n","type":"text"},{"key":"search","value":"","description":"Either search OR article are mandatory
Enables customers and internal users to submit reports regarding search results or issues with existing articles. Users can report instances where a search yields no relevant results or flag issues within articles, such as broken links or incorrect information. Upon successful submission, the endpoint returns 'true'.
\n","urlObject":{"protocol":"https","path":["2.0","external","report.php"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ab6998e3-b340-4c14-8f7d-358a14b09f69"},{"name":"search","id":"b1917ea3-3ea5-47b1-a945-0f23e1a4ad10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"POST","header":[{"description":"\n","key":"APPLICATIONKEY","value":"your-application-key"},{"description":"\n","key":"CONSUMERKEY","value":"your-consumer-key"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"userid","value":"123456","description":"Should always be provided if the search is external
\n","type":"text"},{"key":"query","value":"box look up down off on he she and dinosaur arent not","description":"The actual search term entered by the user
\n","type":"text"},{"key":"channel","value":"14","type":"text"},{"key":"highlight","value":"true","description":"If true, keywords in the search term will be flagged in the result. Defaults to false.
\n","type":"text"},{"key":"autosuggest","value":"false","description":"Use this parameter to indicate whether or not the search is an interim search on keypress. If true, this search will not be logged. It is recommended to turn autosuggest to false on the input of a space, or after a delay of over 1 second.
If true, keywords in the search term will be flagged in the result. Defaults to false.
\n","type":"text","disabled":true},{"key":"snippet","value":"","type":"text","disabled":true},{"key":"min_confidence","value":"","description":"The minimum confidence percentage required in order to return one or more results. Defaults to 0.
\n","type":"text","disabled":true},{"key":"rec_confidence","value":"","description":"The minimum confidence level required to return a recommended result. Defaults to 75.
\n","type":"text","disabled":true},{"key":"viewA","value":"","description":"If provided, only returns search results from the specified view.
\n","type":"text","disabled":true},{"key":"category","value":"","description":"If provided, only returns search results from the specified category.
\n","type":"text","disabled":true},{"key":"sc0","value":"","description":"If provided, only returns search results from the specified subcategories.
\n","type":"text","disabled":true},{"key":"sc1","value":"","description":"If provided, only returns search results from the specified subcategories.
\n","type":"text","disabled":true},{"key":"sc2","value":"","description":"If provided, only returns search results from the specified subcategories.
\n","type":"text","disabled":true},{"key":"count","value":"","description":"Determine the number of results to return as a page from the search results. Defaults to 10.
\n","type":"text","disabled":true},{"key":"index","value":"","description":"Determines the starting point for fetching results from an array of search results, allowing for paginated retrieval of results. Defaults to 0.
\n","type":"text","disabled":true},{"key":"maxresults","value":"","description":"The maximum results to be returned per call. Defaults to 50.
\n","type":"text","disabled":true}]},"url":"https://apisandbox.synthetix.com/2.0/external/search","description":"Executes the Synthetix search using the string provided by the customer. It returns a list of article labels and titles, ordered by relevance.
\n","urlObject":{"protocol":"https","path":["2.0","external","search"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"541c1069-abd7-4f61-b9a0-55de6cbab3f8","name":"search","originalRequest":{"method":"POST","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"userid","value":"123456","description":"Should always be provided if the search is external","type":"text"},{"key":"query","value":"Synthetix","description":"The actual search term entered by the user","type":"text"},{"key":"channel","value":"14","type":"text"},{"key":"highlight","value":"true","description":"If true, keywords in the search term will be flagged in the result. Defaults to false.","type":"text"},{"key":"","value":"","type":"text","disabled":true},{"key":"","value":"","type":"text","disabled":true},{"key":"","value":"","type":"text","disabled":true}]},"url":"https://apisandbox.synthetix.com/2.0/external/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Methods","value":"POST,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Date","value":"Tue, 27 Nov 2018 15:05:21 GMT","enabled":true},{"key":"Expires","value":"2018-11-27T21:05:02+00:00","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-API-Node","value":"ad55ac183250","enabled":true},{"key":"X-API-Version","value":"development;(D3)","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Content-Length","value":"258","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"keywords\": [\n \"Synthetix\"\n ],\n \"results\": [\n {\n \"index\": 0,\n \"label\": \"xxxxxxx\",\n \"faq\": \"How many employees do you have?\",\n \"view\": \"\",\n \"comments\": 0,\n \"matched_keywords\": [\n \"Synthetix\"\n ],\n\t\t\t\t\t\t\"confidence\": 50,\n\t\t\t\t\t\t\"faq_mnemonics\": \"SYNTHETIX EMPLOYEES\",\n \"recommended\": true,\n \"taxonomy\": {\n \"category\": [\n \"About Synthetix\"\n ]\n }\n }\n ],\n \"matchedcats\": {\n \"About Synthetix\": 1\n },\n\t\t\"customer_mnemonics\": \"SYNTHETIX\",\n \"totalresults\": 1,\n \"resultsshown\": 1,\n \"commands\": [],\n \"intent\": null\n}"}],"_postman_id":"b1917ea3-3ea5-47b1-a945-0f23e1a4ad10"},{"name":"session","id":"0110f87b-8713-4447-8ce1-fed9d6c82c7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"DELETE","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"body":{"mode":"raw","raw":""},"url":"https://apisandbox.synthetix.com/2.0/external/session","description":"Destroy an existing session. Once this is called, the session can no longer be used.
\n","urlObject":{"protocol":"https","path":["2.0","external","session"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"86dcfdf9-7540-42a2-bce9-9b610ba18d6c","name":"session","originalRequest":{"method":"DELETE","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"url":"https://apisandbox.synthetix.com/2.0/external/session"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,POST,DELETE,PATCH,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Date","value":"Fri, 26 Oct 2018 08:46:38 GMT","enabled":true},{"key":"Expires","value":"2018-10-26T14:39:01+00:00","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-API-Node","value":"ae7193b82c0a","enabled":true},{"key":"X-API-Version","value":"development;(D3)","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Quota","value":"unlimited/infinite","enabled":true},{"key":"X-Request-ID","value":"1540543598-1718098832-24","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Content-Length","value":"38","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"Destroyed\": true\n}"}],"_postman_id":"0110f87b-8713-4447-8ce1-fed9d6c82c7a"},{"name":"session","id":"8c70319a-69e2-47bd-b907-2aca984ff05d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"url":"https://apisandbox.synthetix.com/2.0/external/session","description":"Verifies the validity of a session at the start of a new session. Returns information regarding the validity of the current token. If the session is deemed invalid or has expired, a new token can be generated.
\n","urlObject":{"protocol":"https","path":["2.0","external","session"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"4b9c50f7-25f1-486d-8373-174e2f1c4e8b","name":"session","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"url":"https://apisandbox.synthetix.com/2.0/external/session"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,POST,DELETE,PATCH,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Date","value":"Fri, 26 Oct 2018 08:42:46 GMT","enabled":true},{"key":"Expires","value":"2018-10-26T14:39:01+00:00","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-API-Node","value":"ae7193b82c0a","enabled":true},{"key":"X-API-Version","value":"development;(D3)","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Quota","value":"unlimited/infinite","enabled":true},{"key":"X-Request-ID","value":"1540543366-1718069457-219","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Content-Length","value":"95","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"ValidToken\": true,\n \"Expired\": false,\n \"ValidApplication\": true,\n \"IP\": true,\n \"view\": \"test\",\n \"return\": false\n}"}],"_postman_id":"8c70319a-69e2-47bd-b907-2aca984ff05d"},{"name":"session","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"token\", jsonData.token);"],"type":"text/javascript","id":"680cae46-97ce-42b5-9f29-8a887885613c"}}],"id":"a432b168-37b0-4766-b058-f30bab887e20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"body":{"mode":"raw","raw":""},"url":"https://apisandbox.synthetix.com/2.0/external/session","description":"Initiates an external session. The returned payload contains the Bearer token required for authentication.
\n","urlObject":{"protocol":"https","path":["2.0","external","session"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"62c02803-6846-4d20-9c82-d9b61a845b14","name":"session","originalRequest":{"method":"POST","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"},{"key":"Content-Type","value":"application/json","disabled":true}],"url":"https://apisandbox.synthetix.com/2.0/external/session"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,POST,DELETE,PATCH,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Date","value":"Wed, 24 Oct 2018 11:42:50 GMT","enabled":true},{"key":"Expires","value":"GMT","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-API-Node","value":"52c20b7818fd","enabled":true},{"key":"X-API-Version","value":"development;(D3)","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Quota","value":"unlimited/infinite","enabled":true},{"key":"X-Request-ID","value":"1540381370-1705158265-27","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Content-Length","value":"68","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\"\n}"}],"_postman_id":"a432b168-37b0-4766-b058-f30bab887e20"},{"name":"session","id":"92a17464-d080-4f78-bef5-dc0247f01cb6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"PATCH","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"view","value":"your-view-name","type":"text"}]},"url":"https://apisandbox.synthetix.com/2.0/external/session","description":"Alters the existing session and view.
\n","urlObject":{"protocol":"https","path":["2.0","external","session"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"0b9d6a33-22e1-42f7-973b-a05e9e62352a","name":"session","originalRequest":{"method":"PATCH","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"view","value":"test","type":"text"}]},"url":"https://apisandbox.synthetix.com/2.0/external/session"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,POST,DELETE,PATCH,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Date","value":"Fri, 26 Oct 2018 08:40:03 GMT","enabled":true},{"key":"Expires","value":"2018-10-26T14:39:01+00:00","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-API-Node","value":"ae7193b82c0a","enabled":true},{"key":"X-API-Version","value":"development;(D3)","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Quota","value":"unlimited/infinite","enabled":true},{"key":"X-Request-ID","value":"1540543203-1718049845-82","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Content-Length","value":"36","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"updated\": true\n}"}],"_postman_id":"92a17464-d080-4f78-bef5-dc0247f01cb6"},{"name":"trigger","id":"521d41d2-245d-495a-ba9c-e6699be61511","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"url":"https://apisandbox.synthetix.com/2.0/external/trigger?url=https://penfield.syn-finity.com","description":"Allows verification of triggers associated with the requested page. It supports checking multiple trigger names and/or URLs in a single call. If any triggers matching the provided criteria are found, the endpoint returns information about them, including their real-time availability, associated skillsets, and trigger styles.
\n","urlObject":{"protocol":"https","path":["2.0","external","trigger"],"host":["apisandbox.synthetix.com"],"query":[{"description":{"content":"The URL you wish to see any triggers for
\n","type":"text/plain"},"key":"url","value":"https://penfield.syn-finity.com"}],"variable":[]}},"response":[{"id":"b79bac09-51bc-4080-b38c-4c38843fa249","name":"trigger","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"url":{"raw":"https://apisandbox.synthetix.com/2.0/external/trigger?url=https://xxxxx.xxxx.xxxxxx.com","protocol":"https","host":["apisandbox","synthetix","com"],"path":["2.0","external","trigger"],"query":[{"key":"url","value":"https://xxxxx.xxxx.xxxxxx.com","description":"The URL you wish to see any triggers for"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,PUT,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Date","value":"Tue, 27 Nov 2018 15:07:02 GMT","enabled":true},{"key":"Expires","value":"2018-11-27T21:05:22+00:00","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-API-Node","value":"ad55ac183250","enabled":true},{"key":"X-API-Version","value":"development;(D3)","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Content-Length","value":"1035","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"triggers\": {\n \"autosuggest\": {\n \"destinationStyle\": \"Lightbox\",\n \"disable_livechat\": false,\n \"effect\": \"sx_fadeIn\",\n \"hideDelay\": \"86400\",\n \"maximise\": true,\n \"online\": true,\n \"text\": \"\",\n \"position\": \"Screen Center\",\n \"showDelay\": \"0\",\n \"target\": \"\",\n \"targetCategory\": \"\",\n \"triggerStyle\": \"popup\",\n \"triggerid\": \"232\",\n \"type\": \"Knowledge\",\n\t\t\t\t\t\t\"availableskillset\": [\n \"Online Customer Service\",\n \"Web self-service\",\n \"Virtual Agents\",\n \"Social Customer Service\",\n \"Technical support\",\n \"RESTful APIs\",\n \"Testing\"\n ],\n\t\t\t\t\t\t\"unavailableskills\": []\n }\n\t\t},\n \"triggersonpage\": 10\n}"}],"_postman_id":"521d41d2-245d-495a-ba9c-e6699be61511"},{"name":"views","id":"ca017838-2da1-4b04-bf9e-4a065eae5ced","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"url":"https://apisandbox.synthetix.com/2.0/external/views","description":"Assesses the views accessible to the application and provides information about the current view, in textual and ID form.
\n","urlObject":{"protocol":"https","path":["2.0","external","views"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"1b5b0f6d-dad3-449c-9c52-63b570576507","name":"views","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"url":"https://apisandbox.synthetix.com/2.0/external/views"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,POST,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Date","value":"Tue, 27 Nov 2018 15:10:49 GMT","enabled":true},{"key":"Expires","value":"2018-11-27T21:05:22+00:00","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-API-Node","value":"ad55ac183250","enabled":true},{"key":"X-API-Version","value":"development;(D3)","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Content-Length","value":"104","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"allowed\": [\n \"FAQs\",\n \"webforms\",\n \"archive\",\n \"zombie\",\n \"test\",\n \"Internal\"\n ],\n \"current\": \"test\",\n \"currentID\": \"1234\"\n}"}],"_postman_id":"ca017838-2da1-4b04-bf9e-4a065eae5ced"}],"id":"c1f461af-3bab-4b41-8a34-d2278d1fa8d8","description":"External endpoints encompass functionalities such as accessing popular articles, retrieving search results, managing session lifecycles, submitting reports, and retrieving information about available views.
\n","_postman_id":"c1f461af-3bab-4b41-8a34-d2278d1fa8d8"},{"name":"helper","item":[{"name":"livechat","item":[{"name":"customer_feedback","id":"621c6a1c-0f9b-46a2-8ef5-92e3345488bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"url":"https://apisandbox.synthetix.com/2.0/helper/livechat/customer_feedback","description":"Provides a list of feedback options that can be used to record customer feedback.
\n","urlObject":{"protocol":"https","path":["2.0","helper","livechat","customer_feedback"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"5e82e9cb-b578-4ab6-bf42-63051dd08893","name":"customer_feedback","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"url":"https://apisandbox.synthetix.com/2.0/helper/livechat/customer_feedback"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 May 2024 09:09:33 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"2715","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,ETag,Last-Modified,Date,HTTP_X_AMZN_TRACE_ID","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=7776000","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"HTTP_X_AMZN_TRACE_ID","value":"Root=1-6633584d-18068335067b6fb64e1cfddc","enabled":true},{"key":"X-API-Node","value":"f7d55a [Nightly]","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS","enabled":true},{"key":"Expires","value":"2024-05-02T14:57:12+00:00","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"customer_feedback\": {\n \"3242\": {\n \"question\": \"Overall, how satisfied were you with the service you received?\",\n \"order\": 1,\n \"type\": \"choice\",\n \"active\": 0,\n \"options\": {\n \"2038\": {\n \"answer\": \"10\",\n \"order\": 1\n },\n \"2039\": {\n \"answer\": \"9\",\n \"order\": 2\n },\n \"2040\": {\n \"answer\": \"8\",\n \"order\": 3\n },\n \"2041\": {\n \"answer\": \"7\",\n \"order\": 4\n },\n \"2042\": {\n \"answer\": \"6\",\n \"order\": 5\n },\n \"2043\": {\n \"answer\": \"5\",\n \"order\": 6\n },\n \"2044\": {\n \"answer\": \"4\",\n \"order\": 7\n },\n \"2045\": {\n \"answer\": \"2\",\n \"order\": 8\n },\n \"2046\": {\n \"answer\": \"1\",\n \"order\": 9\n },\n \"2047\": {\n \"answer\": \"0\",\n \"order\": 10\n }\n }\n },\n \"3244\": {\n \"question\": \"Do you feel that your query has been resolved?\",\n \"order\": 3,\n \"type\": \"choice\",\n \"active\": 0,\n \"options\": {\n \"2056\": {\n \"answer\": \"Yes\",\n \"order\": 1\n },\n \"2057\": {\n \"answer\": \"No\",\n \"order\": 2\n },\n \"2058\": {\n \"answer\": \"Maybe\",\n \"order\": 3\n }\n }\n }\n }\n}"}],"_postman_id":"621c6a1c-0f9b-46a2-8ef5-92e3345488bc"},{"name":"operator_feedback","id":"0df567f4-1c98-497a-8a92-300cf0d4725a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"url":"https://apisandbox.synthetix.com/2.0/helper/livechat/customer_feedback","description":"Provides a list of feedback options that can be used to record operator feedback.
\n","urlObject":{"protocol":"https","path":["2.0","helper","livechat","customer_feedback"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"6586189c-af78-4439-83f0-ed4fb0c87e13","name":"operator_feedback","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"url":"https://apisandbox.synthetix.com/2.0/helper/livechat/operator_feedback"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 May 2024 09:14:15 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"294","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,ETag,Last-Modified,Date,HTTP_X_AMZN_TRACE_ID","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=7776000","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"HTTP_X_AMZN_TRACE_ID","value":"Root=1-66335967-5e02f88c2b906144259f2a78","enabled":true},{"key":"X-API-Node","value":"f7d55a [Nightly]","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS","enabled":true},{"key":"Expires","value":"2024-05-02T14:57:12+00:00","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"agent_feedback\": {\n \"189\": {\n \"question\": \"Choose a category under which to record this chat\",\n \"answers\": [\n \"faqtAgent enquiry\",\n \"knowledgeAgent enquiry\",\n \"liveChat enquiry\",\n \"email enquiry\",\n \"formAgent enquiry\",\n \"Callback enquiry\",\n \"General enquiry\",\n \"Demo chat\",\n \"Test chat\"\n ]\n },\n \"190\": {\n \"question\": \"Was the customer's issue resolved?\",\n \"answers\": [\n \"Yes\",\n \"No\"\n ]\n }\n }\n}"}],"_postman_id":"0df567f4-1c98-497a-8a92-300cf0d4725a"},{"name":"reasons","id":"8b3672a0-da00-4925-8b4b-e2e2ad5eb078","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"url":"https://apisandbox.synthetix.com/2.0/helper/livechat/customer_feedback","description":"Provides a list of end reasons.
\n","urlObject":{"protocol":"https","path":["2.0","helper","livechat","customer_feedback"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"f3f352f7-d324-4162-8f4b-fff9713bb64c","name":"reasons","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"url":"https://apisandbox.synthetix.com/2.0/helper/livechat/reasons"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 May 2024 09:16:21 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"411","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,ETag,Last-Modified,Date,HTTP_X_AMZN_TRACE_ID","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=7776000","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"HTTP_X_AMZN_TRACE_ID","value":"Root=1-663359e5-677ae0c820e75c395f2e460e","enabled":true},{"key":"X-API-Node","value":"f7d55a [Nightly]","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS","enabled":true},{"key":"Expires","value":"2024-05-02T14:57:12+00:00","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"1\": \"Administrator forced chat to end remotely\",\n \"2\": \"Agent clicked End Callback\",\n \"3\": \"Agent clicked End Chat\",\n \"4\": \"Agent closed console without ending chat\",\n \"5\": \"Agent closed console without ending session\",\n \"6\": \"Agent console reports that user ended chat.\",\n \"7\": \"Agent lost connectivity\",\n \"8\": \"Agent replaced console URL\",\n \"9\": \"Chat was transferred successfully\",\n \"10\": \"Customer unavailable\",\n \"11\": \"Customer unavailable SMS Failed\",\n \"12\": \"Customer unavailable SMS Sent\",\n \"13\": \"Dropped from Queue\",\n \"14\": \"Ongoing chat forcefully ended by system\",\n \"15\": \"Operator Ended Chat\",\n \"16\": \"User clicked End Chat button\",\n \"17\": \"User lost connectivity\",\n \"18\": \"User shut down chat application without ending chat\",\n \"19\": \"User did not respond to poke\",\n \"20\": \"User opted not to continue chat\",\n \"21\": \"Customer abandoned chat request\",\n \"22\": \"Chat request timed out before acceptance\"\n}"}],"_postman_id":"8b3672a0-da00-4925-8b4b-e2e2ad5eb078"}],"id":"865bbc5b-d137-4a23-9cbe-69f9c512ca71","_postman_id":"865bbc5b-d137-4a23-9cbe-69f9c512ca71","description":""},{"name":"applications","id":"35253bd3-278d-457a-be0a-e32e08ec6d43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"url":"https://apisandbox.synthetix.com/2.0/helper/applications","description":"Returns a complete list of all applications associated with the Consumerkey.
\n","urlObject":{"protocol":"https","path":["2.0","helper","applications"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"35253bd3-278d-457a-be0a-e32e08ec6d43"},{"name":"audit","id":"046e7f8b-330b-4029-9c11-529ec89ce695","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"url":"https://apisandbox.synthetix.com/2.0/helper/audit","description":"Provides structured data on types, scopes, and actions for auditing purposes
\n","urlObject":{"protocol":"https","path":["2.0","helper","audit"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"262ba371-b80a-4faf-9e62-91ceac9f63a3","name":"audit","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"url":{"raw":"https://apisandbox.synthetix.com/2.0/helper/audit","protocol":"https","host":["apisandbox.synthetix.com"],"path":["2.0","helper","audit"],"query":[{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 May 2024 16:28:38 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"667","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,ETag,Last-Modified,Date,HTTP_X_AMZN_TRACE_ID","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=7776000","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"HTTP_X_AMZN_TRACE_ID","value":"Root=1-66326db6-41b782664ef9464211fa0645","enabled":true},{"key":"X-API-Node","value":"f7d55a [Nightly]","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS","enabled":true},{"key":"Expires","value":"2024-05-01T17:12:26+00:00","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"types\": [\n {\n \"id\": 0,\n \"name\": \"All\"\n },\n {\n \"id\": 1,\n \"name\": \"CREATE\"\n },\n {\n \"id\": 2,\n \"name\": \"DELETE\"\n },\n {\n \"id\": 3,\n \"name\": \"INFO\"\n },\n {\n \"id\": 4,\n \"name\": \"NOTICE\"\n },\n {\n \"id\": 5,\n \"name\": \"SECURITY\"\n },\n {\n \"id\": 6,\n \"name\": \"UPDATE\"\n }\n ],\n \"scopes\": [\n {\n \"id\": 0,\n \"name\": \"All\"\n },\n {\n \"id\": 1,\n \"name\": \"EXTERNAL\"\n },\n {\n \"id\": 2,\n \"name\": \"INTERNAL\"\n },\n {\n \"id\": 3,\n \"name\": \"SYSTEM\"\n }\n ],\n \"actions\": [\n {\n \"id\": 0,\n \"name\": \"All\"\n },\n {\n \"id\": 1,\n \"name\": \"Banned Client - Client attempted access\"\n },\n {\n \"id\": 2,\n \"name\": \"Banned Client - Client ban removed\"\n },\n {\n \"id\": 3,\n \"name\": \"Banned Client - Client Banned\"\n },\n {\n \"id\": 4,\n \"name\": \"Chat Details Viewed\"\n },\n {\n \"id\": 5,\n \"name\": \"Chat Redaction\"\n },\n {\n \"id\": 6,\n \"name\": \"Datadownload Pipeline Created\"\n },\n {\n \"id\": 7,\n \"name\": \"Datadownload Pipeline Deactivating\"\n },\n {\n \"id\": 8,\n \"name\": \"Datadownload removed from SQL and S3\"\n },\n {\n \"id\": 9,\n \"name\": \"Datadownload Pipeline Deleted\"\n },\n {\n \"id\": 10,\n \"name\": \"Email Transcript Emailed\"\n },\n {\n \"id\": 11,\n \"name\": \"Failed Login\"\n },\n {\n \"id\": 12,\n \"name\": \"Failed Password change\"\n },\n {\n \"id\": 13,\n \"name\": \"Flagged Chat - Status Change\"\n },\n {\n \"id\": 14,\n \"name\": \"Flagged Chat - Chat Flagged\"\n },\n {\n \"id\": 15,\n \"name\": \"Knowledge Article Emailed\"\n },\n {\n \"id\": 16,\n \"name\": \"Locked account login attempt\"\n },\n {\n \"id\": 17,\n \"name\": \"Login challenge via email\"\n },\n {\n \"id\": 18,\n \"name\": \"Login challenge via application\"\n },\n {\n \"id\": 19,\n \"name\": \"Logout\"\n },\n {\n \"id\": 20,\n \"name\": \"MFA Challenge configured\"\n },\n {\n \"id\": 21,\n \"name\": \"Notification Deleted\"\n },\n {\n \"id\": 22,\n \"name\": \"Successful login\"\n },\n {\n \"id\": 23,\n \"name\": \"Successful Password change\"\n },\n {\n \"id\": 24,\n \"name\": \"Unknown User Login Attempt\"\n },\n {\n \"id\": 25,\n \"name\": \"User account Locked\"\n },\n {\n \"id\": 26,\n \"name\": \"User account Unlocked automatically\"\n },\n {\n \"id\": 27,\n \"name\": \"User account Unlocked\"\n },\n {\n \"id\": 28,\n \"name\": \"Webhook response\"\n },\n {\n \"id\": 29,\n \"name\": \"Zapier Action Suspend Or Unsuspend\"\n },\n {\n \"id\": 30,\n \"name\": \"Zapier Action Missed and Abandoned chat\"\n },\n {\n \"id\": 31,\n \"name\": \"Zapier Action List Users\"\n },\n {\n \"id\": 32,\n \"name\": \"Canned Response - Global Response Created\"\n },\n {\n \"id\": 33,\n \"name\": \"Canned Response - Global Response Updated\"\n },\n {\n \"id\": 34,\n \"name\": \"Canned Response - Global Response Deleted\"\n },\n {\n \"id\": 35,\n \"name\": \"Useful Links - Global Useful Link Created\"\n },\n {\n \"id\": 36,\n \"name\": \"Useful Links - Global Useful Link Updated\"\n },\n {\n \"id\": 37,\n \"name\": \"Useful Links - Global Useful Link Deleted\"\n }\n ]\n}"}],"_postman_id":"046e7f8b-330b-4029-9c11-529ec89ce695"},{"name":"channels","id":"acbb1b73-bce4-482f-b7be-2dddb0f152fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"url":"https://apisandbox.synthetix.com/2.0/helper/channels","description":"Returns a complete list of all available channels within Synthetix.
\n","urlObject":{"protocol":"https","path":["2.0","helper","channels"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"62bbf741-ea88-42a1-b2bd-01b930616f87","name":"channels","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"url":"https://apisandbox.synthetix.com/2.0/helper/channels"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Date","value":"Tue, 27 Nov 2018 14:10:23 GMT","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-API-Node","value":"0df1b46c168b","enabled":true},{"key":"X-API-Version","value":"staging;(S3)","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Quota","value":"unlimited/infinite","enabled":true},{"key":"X-Request-ID","value":"1543327823-1947137149-110","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Content-Length","value":"197","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 0,\n \"channel\": \"livechat\"\n },\n {\n \"id\": 1,\n \"channel\": \"callback\"\n },\n {\n \"id\": 2,\n \"channel\": \"email\"\n },\n {\n \"id\": 3,\n \"channel\": \"voip\"\n },\n {\n \"id\": 4,\n \"channel\": \"video\"\n },\n {\n \"id\": 5,\n \"channel\": \"whatsapp\"\n },\n {\n \"id\": 6,\n \"channel\": \"skype_im\"\n },\n {\n \"id\": 7,\n \"channel\": \"sms\"\n },\n {\n \"id\": 8,\n \"channel\": \"twitter\"\n },\n {\n \"id\": 9,\n \"channel\": \"ticket\"\n },\n {\n \"id\": 10,\n \"channel\": \"Facebook\"\n },\n {\n \"id\": 14,\n \"channel\": \"Knowledge\"\n },\n {\n \"id\": 15,\n \"channel\": \"IVA\"\n },\n {\n \"id\": 16,\n \"channel\": \"form agent\"\n },\n {\n \"id\": 17,\n \"channel\": \"virtual agent\"\n },\n {\n \"id\": 99,\n \"channel\": \"Unknown\"\n }\n]"}],"_postman_id":"acbb1b73-bce4-482f-b7be-2dddb0f152fc"},{"name":"error","id":"d41b210b-2e6b-47bd-afb3-d511b9c8f28d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apisandbox.synthetix.com/2.0/helper/error","description":"Returns a list of all API error codes and their associated HTTP headers.
\n","urlObject":{"protocol":"https","path":["2.0","helper","error"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"5a8383df-2c6f-459b-a937-e5c23ab139d7","name":"error","originalRequest":{"method":"GET","header":[],"url":"https://apisandbox.synthetix.com/2.0/helper/error"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Jun 2019 13:06:26 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"2117","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified,Date","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-API-Node","value":"77175f (Fri, 21 Jun 2019 13:04:52)","enabled":true},{"key":"X-API-Version","value":"Dev;(D3)","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n {\n \"code\": 101,\n \"description\": \"NOT USING HTTPS 443\",\n \"header\": {\n \"426\": \"Upgrade Required\"\n }\n },\n {\n \"code\": 102,\n \"description\": \"INVALID HEADERS\",\n \"header\": {\n \"406\": \"Not Acceptable\"\n }\n },\n {\n \"code\": 103,\n \"description\": \"API CALL QUOTA LIMIT EXCEEDED\",\n \"header\": {\n \"406\": \"Not Acceptable\",\n \"429\": \"Too Many Requests\"\n }\n },\n {\n \"code\": 104,\n \"description\": \"FORMAT MISSING\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 105,\n \"description\": \"INVALID FORMAT\",\n \"header\": {\n \"405\": \"Method Not Allowed\"\n }\n },\n {\n \"code\": 106,\n \"description\": \"MISSING PARAMETER\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 110,\n \"description\": \"APPLICATION OFFLINE\",\n \"header\": {\n \"423\": \"Locked\"\n }\n },\n {\n \"code\": 111,\n \"description\": \"BAD ORIGIN IP\",\n \"header\": {\n \"403\": \"Forbidden\"\n }\n },\n {\n \"code\": 112,\n \"description\": \"TOKEN DOES NOT CONTAIN VALID SIGNATURE\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 113,\n \"description\": \"TOKEN EXPIRED\",\n \"header\": {\n \"401\": \"Unauthorized\"\n }\n },\n {\n \"code\": 114,\n \"description\": \"INVALID TOKEN\",\n \"header\": {\n \"401\": \"Unauthorized\"\n }\n },\n {\n \"code\": 115,\n \"description\": \"INVALID IP\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 117,\n \"description\": \"DATA NOT VALID\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 124,\n \"description\": \"FAILED TO CONNECT\",\n \"header\": {\n \"503\": \"Service Unavailable\"\n }\n },\n {\n \"code\": 128,\n \"description\": \"HTTP PUT METHOD NOT AVAILABLE\",\n \"header\": {\n \"405\": \"Method Not Allowed\"\n }\n },\n {\n \"code\": 129,\n \"description\": \"HTTP HEAD METHOD NOT AVAILABLE\",\n \"header\": {\n \"405\": \"Method Not Allowed\"\n }\n },\n {\n \"code\": 130,\n \"description\": \"HTTP DELETE METHOD NOT AVAILABLE\",\n \"header\": {\n \"405\": \"Method Not Allowed\"\n }\n },\n {\n \"code\": 131,\n \"description\": \"HTTP OPTIONS METHOD NOT AVAILABLE\",\n \"header\": {\n \"405\": \"Method Not Allowed\"\n }\n },\n {\n \"code\": 132,\n \"description\": \"HTTP GET METHOD NOT AVAILABLE\",\n \"header\": {\n \"405\": \"Method Not Allowed\"\n }\n },\n {\n \"code\": 133,\n \"description\": \"HTTP OPTIONS POST NOT AVAILABLE\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 134,\n \"description\": \"HTTP METHOD NOT ACCEPTED\",\n \"header\": {\n \"405\": \"Method Not Allowed\"\n }\n },\n {\n \"code\": 135,\n \"description\": \"MODE NOT RECOGNIZED\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 136,\n \"description\": \"NO RESULTS\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 137,\n \"description\": \"CANNOT CONNECT\",\n \"header\": {\n \"503\": \"Service Unavailable\"\n }\n },\n {\n \"code\": 144,\n \"description\": \"CANNOT CONNECT\",\n \"header\": {\n \"503\": \"Service Unavailable\"\n }\n },\n {\n \"code\": 145,\n \"description\": \"CANNOT CONNECT\",\n \"header\": {\n \"503\": \"Service Unavailable\"\n }\n },\n {\n \"code\": 146,\n \"description\": \"INVALID CHANNEL\",\n \"header\": {\n \"501\": \"Not Implemented\"\n }\n },\n {\n \"code\": 147,\n \"description\": \"VOID ID\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 148,\n \"description\": \"MISSING OR MALFORMED SKILL\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 149,\n \"description\": \"INVALID SKILL\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 150,\n \"description\": \"INVALID VARIABLE\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 151,\n \"description\": \"3RD PARTY RETURNED INVALID STATUS RESPONSE\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 154,\n \"description\": \"NO DATA\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 155,\n \"description\": \"CANNOT SET 3RD PARTY TIMEOUT\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 156,\n \"description\": \"3RD PARTY INTEGRATION SETTINGS INCOMPLETE\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 157,\n \"description\": \"NO RESULTS\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 158,\n \"description\": \"RATE LIMIT EXCEEDED\",\n \"header\": {\n \"429\": \"Too Many Requests\"\n }\n },\n {\n \"code\": 159,\n \"description\": \"MALFORMED TIME RATE PARAMETER\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 160,\n \"description\": \"3RD PARTY SESSION DOES NOT EXIST\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 161,\n \"description\": \"3RD PARTY ENVIRONMENT HAS A FAULT\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 162,\n \"description\": \"NO RESULTS\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 163,\n \"description\": \"NO SLA DATA\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 164,\n \"description\": \"NO AUTO RESPONDER\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 165,\n \"description\": \"CATEGORY DOES NOT EXIST\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 166,\n \"description\": \"CATEGORY AND SUBCATEGORY ARE INCOMPATIBLE\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 167,\n \"description\": \"CANNOT FIND GLOBAL PRESETS\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 169,\n \"description\": \"INCOMPATIBLE PARAMETERS\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 170,\n \"description\": \"NO ACCESS TO THIS RESOURCE\",\n \"header\": {\n \"403\": \"Forbidden\"\n }\n },\n {\n \"code\": 171,\n \"description\": \"CANNOT CHANGE EXISTING EMAIL\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 173,\n \"description\": \"CSRF SUSPECTED\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 174,\n \"description\": \"ALREADY SUSPENDED\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 175,\n \"description\": \"ALREADY UNSUSPENDED\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 177,\n \"description\": \"VOID TRIGGER ID\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 179,\n \"description\": \"UNKNOWN SUBDOMAIN\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 180,\n \"description\": \"TEAM MATE INVALID\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 181,\n \"description\": \"YOU ARE NOT A PARTICIPANT IN THIS CONVERSATION\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 182,\n \"description\": \"CHAT NOT ASSIGNED TO YOU\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 183,\n \"description\": \"ERROR IN UPDATING OR ADDING AD IMPRESSIONS\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 184,\n \"description\": \"TRANSFER NOT AVAILABLE\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 185,\n \"description\": \"LOGGING FAILURE\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 186,\n \"description\": \"CANNOT REMOVE OWNER\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 187,\n \"description\": \"MURDER, DEATH, KILL. OR (INVALID PARTICIPANT)\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 188,\n \"description\": \"DATABASE UPDATE ERROR\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 189,\n \"description\": \"DUPLICATE CATEGORIES IN KNOWLEDGE BASE\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 190,\n \"description\": \"AGENT IS INACTIVE\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 191,\n \"description\": \"TITLE DOES NOT MEET LIMIT REQUIRMENTS\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 192,\n \"description\": \"INVITATION ALREADY OFFERED\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 193,\n \"description\": \"NO GOALS AVAILABLE\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 194,\n \"description\": \"NO TOKEN OR SESSION IN PAYLOAD\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 195,\n \"description\": \"API DOES NOT EXIST\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 196,\n \"description\": \"YOUR SLOTS ARE FULL\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 197,\n \"description\": \"PROBLEM WITH SUBMITTER\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 198,\n \"description\": \"SKILL NO LONGER ACTIVE\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 201,\n \"description\": \"MISSING APPLICATION KEY\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 202,\n \"description\": \"MISSING CONSUMER KEY\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 203,\n \"description\": \"ANTECEDING ENTITY IN QUEUE\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 204,\n \"description\": \"NOT AUTHORISED\",\n \"header\": {\n \"403\": \"Forbidden\"\n }\n },\n {\n \"code\": 222,\n \"description\": \"NOT AUTHORISED\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 223,\n \"description\": \"YOU HAVE NO PERMISSIONS\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 224,\n \"description\": \"AGENT HAS NO MODULES\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 225,\n \"description\": \"ACCOUNT IS LOCKED\",\n \"header\": {\n \"403\": \"Forbidden\"\n }\n },\n {\n \"code\": 226,\n \"description\": \"USER SET AS LOGGED OUT\",\n \"header\": {\n \"401\": \"Unauthorized\"\n }\n },\n {\n \"code\": 227,\n \"description\": \"CANNOT RETURN TO QUEUE IF INVITATION STILL OUT\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 228,\n \"description\": \"ONGOING CHATS AND DB OUT OF SYNC\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 229,\n \"description\": \"TICKET DOES NOT EXIST\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 230,\n \"description\": \"PERMISSION NOT SET\",\n \"header\": {\n \"401\": \"Unauthorized\"\n }\n },\n {\n \"code\": 231,\n \"description\": \"USERNAME INVALID\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 232,\n \"description\": \"USERNAME ALREADY TAKEN\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 233,\n \"description\": \"EMAIL INVALID\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 234,\n \"description\": \"USER DOES NOT BELONG TO THIS AGENT\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 235,\n \"description\": \"NO MFA METHOD\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 236,\n \"description\": \"RESET SESSIONS\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 237,\n \"description\": \"USER ID VOID\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 238,\n \"description\": \"LABEL ID VOID\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 239,\n \"description\": \"CHAT ALREADY COMPLETE\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 240,\n \"description\": \"ONLY OWNERS CAN END CHATS\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 241,\n \"description\": \"BAD SIGNATURE\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 242,\n \"description\": \"HISTORICAL API CANNOT BE USED FOR REALTIME DATA\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 243,\n \"description\": \"INVALID SCORE\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 244,\n \"description\": \"TRIGGER ID INVALID FOR TYPE\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 245,\n \"description\": \"INVALID REASON FOR SUSPENSION\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 246,\n \"description\": \"PIPELINE NOT OWNED BY USER\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 247,\n \"description\": \"PIPELINE DOES NOT EXIST\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 248,\n \"description\": \"NO BREADCRUMBS COLLECTED\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 249,\n \"description\": \"INVALID USER ID FOR THIS ACTION\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 250,\n \"description\": \"CALLBACK ID NOT RECOGNISED\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 251,\n \"description\": \"CALLBACK ALREADY COMPLETE\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 252,\n \"description\": \"CALLBACK CANCELLED\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 253,\n \"description\": \"CALLBACK ALREADY FAILED\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 254,\n \"description\": \"CALLBACK SLOT BLOCKED OUT\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 255,\n \"description\": \"CALLBACK STILL IN PROGRESS\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 256,\n \"description\": \"CALLBACK EITHER NOT STARTED OR ALREADY COMPLETED\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 257,\n \"description\": \"CALLBACK NOT LOCKED\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 258,\n \"description\": \"CANNOT UNSUSPEND WHILE CALLBACK ONGOING\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 259,\n \"description\": \"ENVIRONMENT NOT ENABLED FOR USE WITH THIS CONSUMER AND/OR APPLICATION\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 260,\n \"description\": \"UNDERGOING MAINTENANCE\",\n \"header\": {\n \"503\": \"Service Unavailable\"\n }\n },\n {\n \"code\": 261,\n \"description\": \"WRITE DATABASE CONNECTION FAILED\",\n \"header\": {\n \"503\": \"Service Unavailable\"\n }\n },\n {\n \"code\": 262,\n \"description\": \"READ DATABASE CONNECTION FAILED \",\n \"header\": {\n \"503\": \"Service Unavailable\"\n }\n },\n {\n \"code\": 263,\n \"description\": \"WRITE DATABASE CONNECTION TIMEEDOUT\",\n \"header\": {\n \"503\": \"Service Unavailable\"\n }\n },\n {\n \"code\": 264,\n \"description\": \"READ DATABASE CONNECTION TIMEOUT\",\n \"header\": {\n \"503\": \"Service Unavailable\"\n }\n },\n {\n \"code\": 265,\n \"description\": \"NO CUSTOMER FEEDBACK CONFIGURED\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 266,\n \"description\": \"INVALID PAYMENTLINKREFERENCEID\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 267,\n \"description\": \"EMPTY LOGIC EXPRESSION\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 268,\n \"description\": \"EVALUATED LOGIC EXPRESSION FAILED\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 303,\n \"description\": \"NO AD DATA\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 304,\n \"description\": \"NO AD DATA\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 305,\n \"description\": \"NO KNOWLEDGE DATA\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 306,\n \"description\": \"NO KNOWLEDGE DATA\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 307,\n \"description\": \"NO KNOWLEDGE DATA\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 309,\n \"description\": \"INVALID VIEW\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 310,\n \"description\": \"DATA NOT MODIFIED\",\n \"header\": {\n \"304\": \"Not Modified\"\n }\n },\n {\n \"code\": 311,\n \"description\": \"INVALID DATE RANGE\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 312,\n \"description\": \"MAGIC LINK EXPIRED OR INVALID\",\n \"header\": {\n \"200\": \"OK\"\n }\n },\n {\n \"code\": 403,\n \"description\": \"NOT AUTHORISED\",\n \"header\": {\n \"403\": \"Forbidden\"\n }\n }\n]"}],"_postman_id":"d41b210b-2e6b-47bd-afb3-d511b9c8f28d"},{"name":"health check","id":"441d6d5e-dd5a-4887-8b7d-b3400f529016","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","type":"text","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","type":"text","description":"\n"}],"url":"https://apisandbox.synthetix.com/2.0/helper/health_check","description":"Ok, it's not really a suprise, it's a health checker. This is just to let you know if the API server is alive or dead. Not very fun really.
\n","urlObject":{"protocol":"https","path":["2.0","helper","health_check"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"6110712f-aa64-43f4-adb4-5addd9a63ec9","name":"health check","originalRequest":{"method":"GET","header":[],"url":"https://apisandbox.synthetix.com/2.0/helper/health_check"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Jun 2019 14:53:48 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"27","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified,Date","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-API-Node","value":"4207c8 (Fri, 21 Jun 2019 13:10:04)","enabled":true},{"key":"X-API-Version","value":"Dev;(D3)","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,HEAD,OPTIONS","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"\"Alive\""}],"_postman_id":"441d6d5e-dd5a-4887-8b7d-b3400f529016"},{"name":"operators","id":"33e118c7-0b5a-4c7e-bd89-ca47a0f6fcf1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"url":"https://apisandbox.synthetix.com/2.0/helper/operators","description":"Returns a list of all users associated with the Applicationkey
\n","urlObject":{"protocol":"https","path":["2.0","helper","operators"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"78df7c85-fbc0-46d7-ad0b-0437ffd72ad3","name":"operators","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"url":"https://apisandbox.synthetix.com/2.0/helper/operators"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 May 2024 16:35:04 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"413","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,ETag,Last-Modified,Date,HTTP_X_AMZN_TRACE_ID","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=7776000","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"HTTP_X_AMZN_TRACE_ID","value":"Root=1-66326f38-690c75823e8f68fd58d6f97b","enabled":true},{"key":"X-API-Node","value":"f7d55a [Nightly]","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS","enabled":true},{"key":"Expires","value":"2024-05-01T17:12:26+00:00","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n {\n \"pk_id\": 1,\n \"name\": \"Alastair Taylor\"\n },\n {\n \"pk_id\": 2,\n \"name\": \"Luke Addington\"\n },\n {\n \"pk_id\": 3,\n \"name\": \"Adam Ashcroft\"\n }\n]"}],"_postman_id":"33e118c7-0b5a-4c7e-bd89-ca47a0f6fcf1"},{"name":"product_status","id":"f35c6cd6-069a-4639-97f4-b5e41213b604","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"url":"https://apisandbox.synthetix.com/2.0/helper/product_status","urlObject":{"protocol":"https","path":["2.0","helper","product_status"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"1c78caf6-dcbd-44fc-823c-386ca29f0ae5","name":"product_status","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"url":"https://apisandbox.synthetix.com/2.0/helper/product_status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 May 2024 16:23:20 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"232","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,ETag,Last-Modified,Date,HTTP_X_AMZN_TRACE_ID","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=7776000","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"HTTP_X_AMZN_TRACE_ID","value":"Root=1-66326c78-69136fdb7309a54947f8db82","enabled":true},{"key":"X-API-Node","value":"f7d55a [Nightly]","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"page\": {\n \"id\": \"xxxxxxxxxx\",\n \"name\": \"Synthetix\",\n \"url\": \"https://synthetix.statuspage.io\",\n \"time_zone\": \"Europe/London\",\n \"updated_at\": \"2024-05-01T11:45:23.198+01:00\"\n },\n \"status\": {\n \"indicator\": \"none\",\n \"description\": \"All Systems Operational\"\n },\n \"system_status\": {\n \"colour\": \"green\",\n \"text\": \"All Systems Operational\",\n \"full_text\": \"All Systems Operational\"\n }\n}"}],"_postman_id":"f35c6cd6-069a-4639-97f4-b5e41213b604"},{"name":"permission_group","id":"53bcbe9e-2f50-4fc2-9d47-f3acfaba893b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"url":"https://apisandbox.synthetix.com/2.0/helper/permission_group","description":"Returns a list of all permission groups associated with the Applicationkey.
\n","urlObject":{"protocol":"https","path":["2.0","helper","permission_group"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"35bed538-33db-440e-a6c2-fc07eb7d0548","name":"permission_group","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"url":"https://apisandbox.synthetix.com/2.0/helper/permission_group"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 May 2024 16:37:51 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"353","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,ETag,Last-Modified,Date,HTTP_X_AMZN_TRACE_ID","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=7776000","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"HTTP_X_AMZN_TRACE_ID","value":"Root=1-66326fdf-47ed401756d8175a08a982a2","enabled":true},{"key":"X-API-Node","value":"f7d55a [Nightly]","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS","enabled":true},{"key":"Expires","value":"2024-05-01T17:12:26+00:00","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"1\": \"Admin\",\n \"2\": \"Livechat Only\",\n \"3\": \"Knowledge Only\",\n \"4\": \"Metrics\",\n \"5\": \"Support\"\n}"}],"_postman_id":"53bcbe9e-2f50-4fc2-9d47-f3acfaba893b"},{"name":"triggers","id":"2f15e679-4a2d-4dd7-bf66-15a04b5a0d51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"url":"https://apisandbox.synthetix.com/2.0/helper/triggers","description":"Returns a list of all triggers associated with the Applicationkey.
\n","urlObject":{"protocol":"https","path":["2.0","helper","triggers"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"66f9b16a-cd57-4acd-89a3-6c705e69bf08","name":"triggers","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"url":"https://apisandbox.synthetix.com/2.0/helper/triggers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 May 2024 16:41:59 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"3038","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,ETag,Last-Modified,Date,HTTP_X_AMZN_TRACE_ID","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=7776000","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"HTTP_X_AMZN_TRACE_ID","value":"Root=1-663270d7-5146582e4508034b2f4f0344","enabled":true},{"key":"X-API-Node","value":"f7d55a [Nightly]","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n {\n \"pk_id\": 1,\n \"name\": \"Synthetix_Website_Callback\",\n \"type\": \"callback\",\n \"style\": \"popup\",\n \"skillset\": {\n \"1\": true,\n \"2\": true,\n \"3\": true,\n },\n \"showDelay\": 0,\n \"hideDelay\": 360,\n \"queueing\": true,\n \"onlineDestinationMobile\": \"\",\n \"onlineImage\": \"\",\n \"onlineText\": \"Callback\",\n \"onlineDestination\": \"\",\n \"offlineDestinationMobile\": \"\",\n \"offlineImage\": \"\",\n \"offlineText\": \"\",\n \"offlineDestination\": \"\",\n \"searchKnowledgeType\": null,\n \"timeframes\": [\n {\n \"Days\": {\n \"Sun\": true,\n \"Mon\": true,\n \"Tue\": true,\n \"Wed\": true,\n \"Thu\": true,\n \"Fri\": true,\n \"Sat\": true\n },\n \"Start\": [\n \"0900\"\n ],\n \"Finish\": [\n \"2359\"\n ]\n }\n ],\n \"fireurl\": [],\n \"position\": \"Bottom Left\",\n \"effect\": \"sx_fadeIn\",\n \"height\": 0,\n \"width\": 0,\n \"destinationStyle\": \"Pop Up\",\n \"targetedArticle\": \"\",\n \"targetedCategory\": \"\",\n \"maximise\": false,\n \"Active\": 1,\n \"disable_livechat\": 0,\n \"targetForm\": 101\n }\n]"}],"_postman_id":"2f15e679-4a2d-4dd7-bf66-15a04b5a0d51"},{"name":"username","id":"339e8889-823d-4ac3-965f-4d089572d4d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"url":"https://apisandbox.synthetix.com/2.0/helper/username?username=testy","description":"Returns true if the passed username exists.
\n","urlObject":{"protocol":"https","path":["2.0","helper","username"],"host":["apisandbox.synthetix.com"],"query":[{"key":"username","value":"testy"}],"variable":[]}},"response":[{"id":"66028bd6-3271-4749-a0f9-ea1b65d80331","name":"username","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"url":{"raw":"https://apisandbox.synthetix.com/2.0/helper/username?username=testy","protocol":"https","host":["apisandbox","synthetix","com"],"path":["2.0","helper","username"],"query":[{"key":"username","value":"testy"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 May 2024 16:45:50 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"35","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,ETag,Last-Modified,Date,HTTP_X_AMZN_TRACE_ID","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=7776000","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"HTTP_X_AMZN_TRACE_ID","value":"Root=1-663271be-336bd86550a5ed20434f395b","enabled":true},{"key":"X-API-Node","value":"f7d55a [Nightly]","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS","enabled":true},{"key":"Expires","value":"2024-05-01T17:12:26+00:00","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"exists\": true\n}"}],"_postman_id":"339e8889-823d-4ac3-965f-4d089572d4d2"},{"name":"views","id":"25d666b9-3b87-48bb-a6c7-f88e57b11364","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"url":"https://apisandbox.synthetix.com/2.0/helper/views","description":"Returns a list of all views associated with the Applicationkey.
\n","urlObject":{"protocol":"https","path":["2.0","helper","views"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"c7a9a3c4-4ea2-42ac-98de-61782005c2e7","name":"views","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"url":"https://apisandbox.synthetix.com/2.0/helper/views"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 May 2024 16:48:26 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"109","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,ETag,Last-Modified,Date,HTTP_X_AMZN_TRACE_ID","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=7776000","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"HTTP_X_AMZN_TRACE_ID","value":"Root=1-6632725a-1b52fc6e2dc682713fcc39cd","enabled":true},{"key":"X-API-Node","value":"f7d55a [Nightly]","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS","enabled":true},{"key":"Expires","value":"2024-05-01T17:12:26+00:00","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"3159\": \"FAQs\",\n \"3160\": \"webforms\",\n \"3166\": \"archive\",\n \"3224\": \"zombie\",\n \"3311\": \"test\",\n \"3320\": \"Internal\",\n \"3694\": \"spanish\"\n}"}],"_postman_id":"25d666b9-3b87-48bb-a6c7-f88e57b11364"},{"name":"skills","id":"3e5bd1c5-b904-4c95-a819-df786026efc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"url":"https://apisandbox.synthetix.com/2.0/helper/skills","description":"Returns an exhaustive list of all skills (including enabled channels and SLA) associated with the Applicationkey.
\n","urlObject":{"protocol":"https","path":["2.0","helper","skills"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"10c0b522-7147-4d5e-9800-2d6085e2d176","name":"skills","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"url":"https://apisandbox.synthetix.com/2.0/helper/skills"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 May 2024 16:14:03 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"368","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,ETag,Last-Modified,Date,HTTP_X_AMZN_TRACE_ID","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=7776000","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"HTTP_X_AMZN_TRACE_ID","value":"Root=1-66326a4b-7c4c73423bfbd81d7369eeae","enabled":true},{"key":"X-API-Node","value":"f7d55a [Nightly]","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS","enabled":true},{"key":"Expires","value":"2024-05-01T17:12:26+00:00","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 123,\n \"skill\": \"Testing\",\n \"channels\": [\n \"Live chat\",\n \"WhatsApp\"\n ],\n \"channels_id\": [\n 0,\n 5\n ],\n \"sla\": [\n {\n \"time\": 5,\n \"channel\": \"Live chat\",\n \"channel_id\": 0\n },\n {\n \"time\": 8,\n \"channel\": \"WhatsApp\",\n \"channel_id\": 5\n }\n ]\n }\n]"}],"_postman_id":"3e5bd1c5-b904-4c95-a819-df786026efc7"}],"id":"7f106915-f60e-4f13-a2a8-129684845a9e","description":"Helper endpoints provide useful information relating to the application, such as exhaustive lists of all channels, skills or views associated with the Applicationkey.
\n","_postman_id":"7f106915-f60e-4f13-a2a8-129684845a9e"},{"name":"metrics","item":[{"name":"livechat","item":[{"name":"public","item":[{"name":"completed (Deprecated)","id":"f98e91bc-7138-43e5-a7fc-b2ba83050f72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"url":"https://apisandbox.synthetix.com/2.0/metrics/livechat/public/completed?startdate=2018-11-20&enddate=2018-11-24","description":"Access to details (excluding transcripts) of individual live chats between a given start and end date. If no start and end date passed in, 'today' used. Information provided includes time requested, time answered, chat status, customer name, chat id, post-chat survey, participants, ring time, duration, wrap up time, interactions, skill, chat type.
\n*** This endpoint has been deprecated, please use metrics/livechat/public/summary for summarised livechat data ***
\n","urlObject":{"protocol":"https","path":["2.0","metrics","livechat","public","completed"],"host":["apisandbox.synthetix.com"],"query":[{"key":"startdate","value":"2018-11-20"},{"key":"enddate","value":"2018-11-24"}],"variable":[]}},"response":[{"id":"da579539-5927-4f98-b4a2-d92ee2f4e36c","name":"completed","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"url":{"raw":"https://apisandbox.synthetix.com/2.0/metrics/livechat/public/completed?startdate=2018-11-20&enddate=2018-11-24","protocol":"https","host":["apisandbox.synthetix.com"],"path":["2.0","metrics","livechat","public","completed"],"query":[{"key":"startdate","value":"2018-11-20"},{"key":"enddate","value":"2018-11-24"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Date","value":"Tue, 27 Nov 2018 15:16:08 GMT","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-API-Node","value":"ad55ac183250","enabled":true},{"key":"X-API-Version","value":"development;(D3)","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Content-Length","value":"3829","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"trigger_list\": {\n \"10\": \"Synthetix_Website_Callback\",\n \"145\": \"Synthetix_website_Penfield\",\n \"146\": \"fa_trigger\",\n \"256\": \"Livechat_Standalon\",\n \"903\": \"knowledge\",\n \"904\": \"autosuggest\",\n \"906\": \"autolaunchchat\"\n },\n \"reason_list\": {\n \"1\": \"Administrator forced chat to end remotely\",\n \"2\": \"Agent clicked End Callback\",\n \"3\": \"Agent clicked End Chat\",\n \"4\": \"Agent closed console without ending chat\",\n \"5\": \"Agent closed console without ending session\",\n \"6\": \"Agent console reports that user ended chat.\",\n \"7\": \"Agent lost connectivity\",\n \"8\": \"Agent replaced console URL\",\n \"9\": \"Chat was transferred successfully\",\n \"10\": \"Customer unavailable\",\n \"11\": \"Customer unavailable SMS Failed\",\n \"12\": \"Customer unavailable SMS Sent\",\n \"13\": \"Dropped from Queue\",\n \"14\": \"Ongoing chat forcefully ended by system\",\n \"15\": \"Operator Ended Chat\",\n \"16\": \"User clicked End Chat button\",\n \"17\": \"User lost connectivity\",\n \"18\": \"User shut down chat application without ending chat\",\n \"19\": \"User did not respond to poke\",\n \"20\": \"User opted not to continue chat\"\n },\n \"fb_list\": {\n \"2574\": {\n \"question\": \"Do you feel your query was answered?\",\n \"order\": \"1\",\n \"type\": \"choice\",\n \"options\": {\n \"472\": {\n \"count\": 0,\n \"answer\": \"Yes\",\n \"order\": \"1\"\n },\n \"473\": {\n \"count\": 0,\n \"answer\": \"Partially\",\n \"order\": \"2\"\n },\n \"474\": {\n \"count\": 0,\n \"answer\": \"No\",\n \"order\": \"3\"\n }\n }\n },\n \"2575\": {\n \"question\": \"How would you rate your conversation?\",\n \"order\": \"2\",\n \"type\": \"choice\",\n \"options\": {\n \"475\": {\n \"count\": 0,\n \"answer\": \" Great\",\n \"order\": \"1\"\n },\n \"476\": {\n \"count\": 0,\n \"answer\": \"Average\",\n \"order\": \"2\"\n },\n \"477\": {\n \"count\": 0,\n \"answer\": \"Awful\",\n \"order\": \"3\"\n }\n }\n },\n \"2576\": {\n \"question\": \"Would you use this service again?\",\n \"order\": \"3\",\n \"type\": \"choice\",\n \"options\": {\n \"478\": {\n \"count\": 0,\n \"answer\": \"Yes\",\n \"order\": \"1\"\n },\n \"479\": {\n \"count\": 0,\n \"answer\": \"No\",\n \"order\": \"2\"\n }\n }\n },\n \"2577\": {\n \"question\": \"Leave your comment:\",\n \"order\": \"4\",\n \"type\": \"text\"\n }\n },\n \"skills_matrix\": {\n \"101\": {\n \"skill\": \"Online Customer Service\"\n },\n \"102\": {\n \"skill\": \"Web self-service\"\n },\n \"103\": {\n \"skill\": \"Virtual Agents\"\n },\n \"104\": {\n \"skill\": \"Live Chat\"\n },\n \"105\": {\n \"skill\": \"Social Customer Service\"\n },\n \"106\": {\n \"skill\": \"Technical support\"\n },\n \"107\": {\n \"skill\": \"Email and Webforms\"\n }\n },\n \"completed_chats\": [\n {\n \"date\": 1542672000,\n \"chats\": [\n [\n {\n \"requested\": \"2018-11-20 11:56:21\",\n \"spec_id_requested\": \"101\",\n \"accepted\": \"2018-11-20 11:56:23\",\n \"customer_name\": \"test\",\n \"chat_id\": \"83I5NMhe4MJVej\",\n \"post_chat_survey\": [\n {\n \"question\": \"Choose a category under which to record this chat\",\n \"answer\": \"liveChat enquiry\"\n },\n {\n \"question\": \"Was the customer's issue resolved?\",\n \"answer\": \"No\"\n }\n ],\n \"interactions\": 1,\n \"agents\": [\n \"John Smith\"\n ],\n \"ring_time\": \"00:00:02\",\n \"duration\": \"00:03:36\",\n \"wrap_up_time\": \"00:00:02\",\n \"type_of_chat\": \"single\"\n },\n {\n \"requested\": \"2018-11-20 15:06:09\",\n \"spec_id_requested\": \"429\",\n \"accepted\": \"2018-11-20 15:06:45\",\n \"customer_name\": \"Jim\",\n \"chat_id\": \"54aHvv8qI5WBiP\",\n \"post_chat_survey\": [\n {\n \"question\": \"Choose a category under which to record this chat\",\n \"answer\": \"Test chat\"\n },\n {\n \"question\": \"Was the customer's issue resolved?\",\n \"answer\": \"Yes\"\n }\n ],\n \"interactions\": 5,\n \"agents\": [\n \"James Smith\"\n ],\n \"ring_time\": \"00:00:36\",\n \"duration\": \"00:42:32\",\n \"wrap_up_time\": \"00:00:30\",\n \"type_of_chat\": \"single\"\n },\n {\n \"requested\": \"2018-11-20 15:17:08\",\n \"spec_id_requested\": \"422\",\n \"accepted\": \"2018-11-20 15:17:17\",\n \"customer_name\": \"TEST - Gail Edgar\",\n \"chat_id\": \"SFbjIkRnLyhbLf\",\n \"post_chat_survey\": [\n {\n \"question\": \"Choose a category under which to record this chat\",\n \"answer\": \"liveChat enquiry\"\n },\n {\n \"question\": \"Was the customer's issue resolved?\",\n \"answer\": \"Yes\"\n }\n ],\n \"interactions\": 9,\n \"agents\": [\n \"John Smith\"\n ],\n \"ring_time\": \"00:00:09\",\n \"duration\": \"00:04:43\",\n \"wrap_up_time\": \"00:00:25\",\n \"type_of_chat\": \"single\"\n },\n {\n \"requested\": \"2018-11-20 15:17:10\",\n \"spec_id_requested\": \"422\",\n \"accepted\": \"2018-11-20 15:17:14\",\n \"customer_name\": \"TEST - Raddie Whiteoak\",\n \"chat_id\": \"4ZKXB8MPohoSk8\",\n \"post_chat_survey\": [\n {\n \"question\": \"Choose a category under which to record this chat\",\n \"answer\": \"Operator did not provide feedback within 3 hours of chat end\"\n },\n {\n \"question\": \"Was the customer\\\\'s issue resolved?\",\n \"answer\": \"Operator did not provide feedback within 3 hours of chat end\"\n }\n ],\n \"interactions\": 23,\n \"agents\": [\n \"John Smith\",\n \"James Smith\"\n ],\n \"ring_time\": \"00:00:04\",\n \"duration\": \"00:41:39\",\n \"wrap_up_time\": \"02:55:07\",\n \"type_of_chat\": \"group\"\n }\n ]\n ]\n },\n {\n \"date\": 1542758400,\n \"chats\": [\n [\n {\n \"requested\": \"2018-11-21 14:49:01\",\n \"spec_id_requested\": \"428\",\n \"accepted\": \"2018-11-21 14:49:12\",\n \"customer_name\": \"TEST - Montgomery Abbet\",\n \"chat_id\": \"LlCORkukaFfCAP\",\n \"post_chat_survey\": [\n {\n \"question\": \"Choose a category under which to record this chat\",\n \"answer\": \"faqtAgent enquiry\"\n },\n {\n \"question\": \"Was the customer's issue resolved?\",\n \"answer\": \"Yes\"\n }\n ],\n \"interactions\": 10,\n \"agents\": [\n \"John Smith\"\n ],\n \"ring_time\": \"00:00:11\",\n \"duration\": \"00:04:19\",\n \"wrap_up_time\": \"00:01:37\",\n \"type_of_chat\": \"single\"\n },\n {\n \"requested\": \"2018-11-21 14:49:03\",\n \"spec_id_requested\": \"424\",\n \"accepted\": \"2018-11-21 14:49:39\",\n \"customer_name\": \"TEST - Emmery Crockford\",\n \"chat_id\": \"y4vCK8pMirfPGs\",\n \"post_chat_survey\": [\n {\n \"question\": \"Choose a category under which to record this chat\",\n \"answer\": \"liveChat enquiry\"\n },\n {\n \"question\": \"Was the customer's issue resolved?\",\n \"answer\": \"Yes\"\n }\n ],\n \"interactions\": 14,\n \"agents\": [\n \"James Smith\"\n ],\n \"ring_time\": \"00:00:36\",\n \"duration\": \"00:04:23\",\n \"wrap_up_time\": \"00:00:13\",\n \"type_of_chat\": \"single\"\n },\n {\n \"requested\": \"2018-11-21 14:49:05\",\n \"spec_id_requested\": \"426\",\n \"accepted\": \"2018-11-21 14:49:15\",\n \"customer_name\": \"TEST - Nonah Gergus\",\n \"chat_id\": \"CiMo4uebefpTpo\",\n \"post_chat_survey\": [\n {\n \"question\": \"Choose a category under which to record this chat\",\n \"answer\": \"email enquiry\"\n },\n {\n \"question\": \"Was the customer's issue resolved?\",\n \"answer\": \"Yes\"\n }\n ],\n \"interactions\": 34,\n \"agents\": [\n \"Bill Smith\"\n ],\n \"ring_time\": \"00:00:10\",\n \"duration\": \"00:05:16\",\n \"wrap_up_time\": \"00:00:04\",\n \"type_of_chat\": \"single\"\n }\n ]\n ]\n }\n ]\n}"}],"_postman_id":"f98e91bc-7138-43e5-a7fc-b2ba83050f72"},{"name":"feedback","id":"f1784514-1d2d-4ac8-91d0-d992f80220c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"url":"https://apisandbox.synthetix.com/2.0/metrics/livechat/public/feedback?startdate=2023-01-01&enddate=2023-12-31","description":"Returns customer feedback for each live chat by user including textual feedback, likes, sentiment analysis.
\n","urlObject":{"protocol":"https","path":["2.0","metrics","livechat","public","feedback"],"host":["apisandbox.synthetix.com"],"query":[{"key":"startdate","value":"2023-01-01"},{"key":"enddate","value":"2023-12-31"},{"disabled":true,"description":{"content":"int Filter by user id
Returns data concerning missed and abandoned chats. If no start date or end date passed, 'today' data returned.
\n","urlObject":{"protocol":"https","path":["2.0","metrics","livechat","public","missed"],"host":["apisandbox.synthetix.com"],"query":[{"disabled":true,"key":"startdate","value":"2023-01-01"},{"disabled":true,"key":"enddate","value":"2023-12-31"},{"disabled":true,"description":{"content":"string Filter by topic
Returns realtime livechat data. Please note, even if only one parameter is requested, the data_requested requires an array to be sent in.
\n","urlObject":{"protocol":"https","path":["2.0","metrics","livechat","public","realtime"],"host":["apisandbox.synthetix.com"],"query":[{"description":{"content":"request for integer value of total chats for current day
\n","type":"text/plain"},"key":"data_requested[]","value":"totalchats"},{"description":{"content":"request for used and available slots by skill
\n","type":"text/plain"},"key":"data_requested[]","value":"availableslots"},{"description":{"content":"request for integer value of abandoned chats for current day
\n","type":"text/plain"},"key":"data_requested[]","value":"abandonedchats"},{"description":{"content":"request for integer value of completed chats for current day
\n","type":"text/plain"},"key":"data_requested[]","value":"completedchats"},{"description":{"content":"request for integer value of missed chats for current day
\n","type":"text/plain"},"key":"data_requested[]","value":"missedchats"},{"description":{"content":"request for integer value of ongoing chats at this moment
\n","type":"text/plain"},"key":"data_requested[]","value":"ongoingchats"},{"description":{"content":"request for status of logged in users
\n","type":"text/plain"},"key":"data_requested[]","value":"userstatus"},{"description":{"content":"request for integer value of currently requested chats
\n","type":"text/plain"},"key":"data_requested[]","value":"requestedchats"},{"description":{"content":"request for maximum slots for logged in users
\n","type":"text/plain"},"key":"data_requested[]","value":"usermax"},{"description":{"content":"request for realtime chat numbers for logged in users
\n","type":"text/plain"},"key":"data_requested[]","value":"userchats"}],"variable":[]}},"response":[{"id":"40ba2bd2-9823-4403-b360-2901018df1a6","name":"realtime","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"url":{"raw":"https://apisandbox.synthetix.com/2.0/metrics/livechat/public/realtime?data_requested[]=totalchats&data_requested[]=availableslots&data_requested[]=abandonedchats&data_requested[]=completedchats&data_requested[]=missedchats&data_requested[]=ongoingchats&data_requested[]=userstatus&data_requested[]=requestedchats&data_requested[]=usermax&data_requested[]=userchats","protocol":"https","host":["apisandbox.synthetix.com"],"path":["2.0","metrics","livechat","public","realtime"],"query":[{"key":"data_requested[]","value":"totalchats","description":"request for integer value of total chats for current day"},{"key":"data_requested[]","value":"availableslots","description":"request for used and available slots by skill"},{"key":"data_requested[]","value":"abandonedchats","description":"request for integer value of abandoned chats for current day"},{"key":"data_requested[]","value":"completedchats","description":"request for integer value of completed chats for current day"},{"key":"data_requested[]","value":"missedchats","description":"request for integer value of missed chats for current day"},{"key":"data_requested[]","value":"ongoingchats","description":"request for integer value of ongoing chats at this moment"},{"key":"data_requested[]","value":"userstatus","description":"request for status of logged in users"},{"key":"data_requested[]","value":"requestedchats","description":"request for integer value of currently requested chats"},{"key":"data_requested[]","value":"usermax","description":"request for maximum slots for logged in users"},{"key":"data_requested[]","value":"userchats","description":"request for realtime chat numbers for logged in users"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 07 May 2024 09:42:55 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"401","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,ETag,Last-Modified,Date,HTTP_X_AMZN_TRACE_ID","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=7776000","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"HTTP_X_AMZN_TRACE_ID","value":"Root=1-6639f79f-03ce264516b31ab3150d8af9","enabled":true},{"key":"X-API-Node","value":"8e74b1 [Nightly]","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS","enabled":true},{"key":"Expires","value":"2024-05-07T10:37:55+00:00","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"livechat\": {\n \"abandoned\": 0,\n \"completed\": 1,\n \"missed\": 0,\n \"ongoing\": 0,\n \"requested\": 0,\n \"total\": 1\n },\n \"availableslots\": [\n {\n \"skill\": \"Online Customer Service\",\n \"chats\": 0,\n \"slots remaining\": 1\n },\n {\n \"skill\": \"Web self-service\",\n \"chats\": 0,\n \"slots remaining\": 1\n },\n {\n \"skill\": \"Virtual Agents\",\n \"chats\": 0,\n \"slots remaining\": 0\n },\n {\n \"skill\": \"Live Chat\",\n \"chats\": 0,\n \"slots remaining\": 0\n },\n {\n \"skill\": \"Social Customer Service\",\n \"chats\": 0,\n \"slots remaining\": 0\n },\n {\n \"skill\": \"Technical support\",\n \"chats\": 0,\n \"slots remaining\": 0\n },\n {\n \"skill\": \"Email and Webforms\",\n \"chats\": 0,\n \"slots remaining\": 0\n },\n {\n \"skill\": \"Testing\",\n \"chats\": 0,\n \"slots remaining\": 0\n },\n {\n \"skill\": \"RESTful APIs\",\n \"chats\": 0,\n \"slots remaining\": 1\n },\n {\n \"skill\": \"Accounts\",\n \"chats\": 0,\n \"slots remaining\": 0\n },\n {\n \"skill\": \"isolated skill\",\n \"chats\": 0,\n \"slots remaining\": 0\n }\n ],\n \"user status\": [\n {\n \"id\": 18934,\n \"user\": \"Hayley Jude\",\n \"username\": \"Hej\",\n \"nickname\": \"Hej\",\n \"status\": \"not logged into chat\",\n \"chats\": 0,\n \"max\": 3\n },\n {\n \"id\": 20208,\n \"user\": \"Rasmus Lerdorf\",\n \"username\": \"Rasmus\",\n \"nickname\": \"Ras\",\n \"status\": \"available\",\n \"chats\": 0,\n \"max\": 1\n }\n ]\n}"}],"_postman_id":"00b95942-3e5a-40f2-b9c4-e48a6e7e2867"},{"name":"summary","id":"533e4d28-82a5-4a8b-84b7-78051fcccb1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"url":"https://apisandbox.synthetix.com/2.0/metrics/livechat/public/summary?startdate=2018-11-03&enddate=2018-11-06","description":"Provides access to summarised livechat data by user, by chat and in a timeline by individual chat
\n","urlObject":{"protocol":"https","path":["2.0","metrics","livechat","public","summary"],"host":["apisandbox.synthetix.com"],"query":[{"description":{"content":"If no start date or end date passed, 'today' data returned
\n","type":"text/plain"},"key":"startdate","value":"2018-11-03"},{"description":{"content":"If no start date or end date passed, 'today' data returned
\n","type":"text/plain"},"key":"enddate","value":"2018-11-06"}],"variable":[]}},"response":[{"id":"7fc629f6-83eb-40a5-8715-effa9ad758e3","name":"summary","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"url":{"raw":"https://apisandbox.synthetix.com/2.0/metrics/livechat/public/summary?startdate=2018-11-03&enddate=2018-11-06","protocol":"https","host":["apisandbox","synthetix","com"],"path":["2.0","metrics","livechat","public","summary"],"query":[{"key":"startdate","value":"2018-11-03","description":"If no start date or end date passed, 'today' data returned"},{"key":"enddate","value":"2018-11-06","description":"If no start date or end date passed, 'today' data returned"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Date","value":"Tue, 27 Nov 2018 15:13:25 GMT","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-API-Node","value":"ad55ac183250","enabled":true},{"key":"X-API-Version","value":"development;(D3)","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Content-Length","value":"727","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"skillmatrix\": {\n \"123\": \"Online Customer Service\",\n \"122\": \"Web self-service\",\n \"124\": \"Virtual Agents\",\n \"126\": \"Live Chat\",\n \"345\": \"Social Customer Service\",\n \"849\": \"Technical support\",\n \"127\": \"Email and Webforms\"\n },\n \"userdata\": [\n {\n \"user\": {\n \"username\": \"djlasdfjioe\",\n \"fullname\": \"Thomas Smith\"\n },\n \"total_user_chats\": 5,\n \"user_ongoing_chats\": 0,\n \"av_ring_time\": \"00:00:09\",\n \"av_chat_time\": \"00:04:25\",\n \"av_wrapup_time\": \"174\",\n \"total_likes\": \"0\"\n },\n {\n \"user\": {\n \"username\": \"fsdajhwesio\",\n \"fullname\": \"James Smith\"\n },\n \"total_user_chats\": 4,\n \"user_ongoing_chats\": 0,\n \"av_ring_time\": \"00:00:04\",\n \"av_chat_time\": \"00:36:30\",\n \"av_wrapup_time\": \"17461\",\n \"total_likes\": \"0\"\n }\n ],\n \"totalchats\": 9,\n \"missedchats\": 0,\n \"ongoingchats\": 0,\n \"completedchats\": 9,\n \"abandonedchats\": 0,\n \"chats_detail\": {\n \"2018-11-06\": {\n \"completed\": \"9\",\n \"taken\": \"9\",\n \"requested\": \"9\"\n }\n },\n \"timeline\": [\n {\n \"date\": \"2018-11-06\",\n \"chatid\": \"Qt9vrP0pVwJjo\",\n \"skillid\": 425,\n \"skill\": \"Live Chat\",\n \"start_time\": \"11:29:48\",\n \"end_time\": \"12:55:44\"\n },\n {\n \"date\": \"2018-11-06\",\n \"chatid\": \"rBLLvV6X79qDM\",\n \"skillid\": 429,\n \"skill\": \"Testing\",\n \"start_time\": \"14:12:41\",\n \"end_time\": \"14:13:50\"\n },\n {\n \"date\": \"2018-11-06\",\n \"chatid\": \"nj7mwaPUrBX36\",\n \"skillid\": 429,\n \"skill\": \"Testing\",\n \"start_time\": \"14:14:38\",\n \"end_time\": \"14:16:08\"\n },\n {\n \"date\": \"2018-11-06\",\n \"chatid\": \"lOnAr72m8dDiN\",\n \"skillid\": 422,\n \"skill\": \"Online Customer Service\",\n \"start_time\": \"14:35:13\",\n \"end_time\": \"14:35:14\"\n },\n {\n \"date\": \"2018-11-06\",\n \"chatid\": \"5cqnzoR7PehRe\",\n \"skillid\": 429,\n \"skill\": \"Testing\",\n \"start_time\": \"14:36:43\",\n \"end_time\": \"14:41:29\"\n },\n {\n \"date\": \"2018-11-06\",\n \"chatid\": \"dAWwJNpjRl2Zg\",\n \"skillid\": 429,\n \"skill\": \"Testing\",\n \"start_time\": \"14:42:21\",\n \"end_time\": \"14:52:48\"\n },\n {\n \"date\": \"2018-11-06\",\n \"chatid\": \"BWmQS4HRNyZFc\",\n \"skillid\": 429,\n \"skill\": \"Testing\",\n \"start_time\": \"14:53:45\",\n \"end_time\": \"14:57:57\"\n },\n {\n \"date\": \"2018-11-06\",\n \"chatid\": \"aldbvJkv5UPZI\",\n \"skillid\": 425,\n \"skill\": \"Live Chat\",\n \"start_time\": \"16:19:00\",\n \"end_time\": \"17:19:00\"\n },\n {\n \"date\": \"2018-11-06\",\n \"chatid\": \"5TjNOd0w8E46K\",\n \"skillid\": 425,\n \"skill\": \"Live Chat\",\n \"start_time\": \"17:19:53\",\n \"end_time\": \"17:19:54\"\n }\n ]\n}"}],"_postman_id":"533e4d28-82a5-4a8b-84b7-78051fcccb1b"}],"id":"fd97f235-2457-4b3f-a79c-905e77d3a2a6","_postman_id":"fd97f235-2457-4b3f-a79c-905e77d3a2a6","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":true,"source":{"_postman_id":"882b98cb-6acf-41d0-89ad-021310c34f6e","id":"882b98cb-6acf-41d0-89ad-021310c34f6e","name":"metrics","type":"folder"}}},{"name":"lc_chat_history_summary","id":"62ad2019-804f-4eea-b7f9-48ac00d2453e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n","type":"text"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n","type":"text"}],"url":"https://apisandbox.synthetix.com/2.0/metrics/livechat/lc_chat_history_summary","description":"Provides access to summarised livechat data of completed chat and ongoing chats. A variety of parameters are available to customise the returned data to facilitate analysis and insights for highly specific metrics.
\n","urlObject":{"protocol":"https","path":["2.0","metrics","livechat","lc_chat_history_summary"],"host":["apisandbox.synthetix.com"],"query":[{"disabled":true,"description":{"content":"If no start date or end date passed, 'today' data returned
\n","type":"text/plain"},"key":"startdate","value":"07-05-2024"},{"disabled":true,"description":{"content":"If no start date or end date passed, 'today' data returned
\n","type":"text/plain"},"key":"enddate","value":"07-05-2024"},{"disabled":true,"key":"index","value":"0"},{"disabled":true,"description":{"content":"int Max amount of results returned
int Filter by trigger
int Filter by chat end reason
int Filter by chat skill
int Filter by chat owner
string Filter by chat reference
string Filter by chat status. a = abondoned, c = completed, m = missed,
int Filter by channel
boolean Refresh the results
string Specify a search value such as a name or email
int[] Filter by feedback answer
object[] Filter by chat wrap up. Object should be value pairs of {\"id\": \"name\"}
Rerturns a summary of recorded article activity.
\n","urlObject":{"protocol":"https","path":["2.0","metrics","knowledge","external","article_history"],"host":["apisandbox.synthetix.com"],"query":[{"description":{"content":"Application key designating the application whose statistics are being queried.
\n","type":"text/plain"},"key":"appkey","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"startdate","value":"30-04-2024"},{"key":"enddate","value":"06-05-2024"},{"description":{"content":"int Filter by channel. Defaults to 14 if no channel provided.
Returns a count of the number of interactions for each recorded useragent over the selected period. If no start date or end date are given, the data is restricted to 'today'.
\n","urlObject":{"protocol":"https","path":["2.0","metrics","knowledge","external","device"],"host":["apisandbox.synthetix.com"],"query":[{"description":{"content":"Application key designating the application whose statistics are being queried.
\n","type":"text/plain"},"key":"appkey","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"startdate","value":"2023-01-01"},{"key":"enddate","value":"2023-12-31"},{"disabled":true,"description":{"content":"int Filter by view
int Filter by channel
Returns escalation data for the requested application with data that varies depending on the charttype parameter.
charttype 3 returns a list of escalations and the count within the specified date range.
\n[\n {\n \"label\": \"introka\",\n \"article\": \"\",\n \"escalations\": \"50\"\n },\n {\n \"label\": \"lbl00037\",\n \"article\": \"What should I do if I suspect fraud?\",\n \"escalations\": \"7\"\n }\n]\n\ncharttype 9 returns a count of escalations on a daily basis within the specified date range.
\n[\n [\n {\n \"name\": \"2023-01-01\",\n \"escalations\": 0\n },\n {\n \"name\": \"2023-01-02\",\n \"escalations\": 0\n }\n ]\n]\n\ncharttype 9 returns a count of escalations on a daily basis within the specified date range.
\n[\n {\n \"name\": \"2023-01-01\",\n \"escalations\": 0\n },\n {\n \"name\": \"2023-01-02\",\n \"escalations\": 0\n }\n]\n\nApplication key designating the application whose statistics are being queried.
\n","type":"text/plain"},"key":"appkey","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"description":{"content":"mandatory
mandatory
int Filter by chart type
Returns feedback data for the requested application with data that varies depending on the charttype parameter.
charttype 1 returns positive and negative results count within the specified date range.
\n{\n \"2019-01-11 13:18:33\": [\n {\n \"name\": \"Positive results\",\n \"value\": 19\n },\n {\n \"name\": \"Negative results\",\n \"value\": 11\n }\n ]\n}\n\ncharttype 3 returns feedback within the specified date range.
\n{\n \"2019-01-11 13:18:33\": [\n {\n \"article\": \"What is Synthetix?\",\n \"label\": \"label1\",\n \"category\": \"Contact Centre Cloud\",\n \"comments\": 0,\n \"comments_content\": [],\n \"Q1A1\": 1,\n \"Q1A2\": 0,\n \"Q2A1\": 0,\n \"Q2A2\": 0\n },\n {\n \"article\": \"How do I contact you\",\n \"label\": \"label2\",\n \"category\": \"About Synthetix\",\n \"comments\": 5,\n \"comments_content\": {\n \"Comment 1\": \"cool\",\n \"Comment 2\": \"new\",\n \"Comment 3\": \"test\",\n },\n \"Q1A1\": 6,\n \"Q1A2\": 5,\n \"Q2A1\": 5,\n \"Q2A2\": 0\n }\n ]\n}\n\ncharttype 4 and 6 returns the positive and negative feedback count on a daily basis within the specified date range.
\n{\n \"2019-01-11 13:18:33\": [\n {\n \"name\": \"2018-01-01\",\n \"positive_results\": 0,\n \"negative_results\": 0\n },\n {\n \"name\": \"2018-01-02\",\n \"positive_results\": 0,\n \"negative_results\": 0\n }\n ]\n}\n\ncharttype 8 returns comment and submitted count within the specified date range.
\n{\n \"2017-12-19 17:45:58\": {\n \"comments_left\": 0,\n \"feedback_submitted\": 0\n },\n \"2018-01-05 14:59:32\": {\n \"comments_left\": \"9\",\n \"feedback_submitted\": \"20\"\n }\n}\n\ncharttype 11 or no charttype returns feedback data including count and percentage within the specified date range.
\n{\n \"2019-01-11 13:18:33\": {\n \"How Did this answer your question?\": [\n {\n \"answer\": \"Yes\",\n \"value\": \"10\",\n \"percent\": 50,\n \"relative_percent\": 100\n },\n {\n \"answer\": \"No\",\n \"value\": \"10\",\n \"percent\": 50,\n \"relative_percent\": 100\n }\n ],\n \"Are you sure?\": [\n {\n \"answer\": \"Yes\",\n \"value\": \"9\",\n \"percent\": 90,\n \"relative_percent\": 100\n },\n {\n \"answer\": \"No\",\n \"value\": \"1\",\n \"percent\": 10,\n \"relative_percent\": 11.11\n }\n ]\n }\n}\n\nApplication key designating the application whose statistics are being queried.
\n","type":"text/plain"},"key":"appkey","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"description":{"content":"mandatory
mandatory
int Filter by chart type
int Filter by channel
Returns a summary of sessions generated by country with data that varies depending on the charttype parameter.
charttype 4 returns a daily count for each country on a daily basis within the specified date range.
\n[\n {\n \"Ireland\": 0,\n \"name\": \"2023-01-01\"\n },\n {\n \"Ireland\": 0,\n \"name\": \"2023-01-02\"\n }\n]\n\ncharttype 12 or no charttype returns a list of countries is returned with a count value.
\n[\n {\n \"id\": \"IE\",\n \"name\": \"Ireland\",\n \"value\": 1\n }\n]\n\nApplication key designating the application whose statistics are being queried.
\n","type":"text/plain"},"key":"appkey","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"description":{"content":"mandatory
mandatory
int Filter by charttype
int Filter by channel. Defaults to 14 when no channel is specfifed.
Returns a list of top categories with data that varies depending on the charttype parameter.
charttype 3 returns a list of top categories and the total hit count within the specified date range.
\n[\n {\n \"cat_id\": 24970,\n \"category\": \"Contact Centre Cloud\",\n \"hits\": 188,\n \"percent\": 75.2\n },\n {\n \"cat_id\": 26628,\n \"category\": \"Test\",\n \"hits\": 36,\n \"percent\": 14.4\n }\n]\n\ncharttype 9 returns the total hit count for top categories on a daily basis within the specified date range.
\n[\n [\n {\n \"name\": \"2023-01-01\",\n \"id\": 24970,\n \"Contact Centre Cloud\": 0\n },\n {\n \"name\": \"2023-01-02\",\n \"id\": 24970,\n \"Contact Centre Cloud\": 0\n }\n ]\n] \n\nNo charttype returns ategories and the total hit count within the specified date range.
\n[\n {\n \"category\": \"Contact Centre Cloud\",\n \"hits\": 188\n },\n {\n \"category\": \"Test\",\n \"hits\": 36\n }\n]\n\nApplication key designating the application whose statistics are being queried.
\n","type":"text/plain"},"key":"appkey","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"description":{"content":"mandatory
mandatory
int Filter by channel
int Filter by charttype
int[] Filter by category id
Returns a list of triggers with data that varies depending on the charttype parameter.
charttype 4 and 9 returns the total hit count for triggers on a daily basis within the specified date range. Please note that charttype 4 requires a triggerid to be specified in the request.
\n[\n [\n {\n \"name\": \"2023-01-01\",\n \"total_hits\": 2\n },\n {\n \"name\": \"2023-01-02\",\n \"total_hits\": 9\n }\n ]\n]\n\ncharttype 8 returns a list of triggers with the total hit count of the triggers within the specified date range.
\n[\n {\n \"id\": 1234,\n \"name\": \"SynthetixTestTrigger\",\n \"hits\": 12\n }\n]\n\nNo charttype returns a list of triggers.
\n[\n {\n \"123\": \"SynthetixTrigger\",\n \"456\": \"Knowledge\",\n \"789\": \"AutoSuggest\"\n }\n]\n\nApplication key designating the application whose statistics are being queried.
\n","type":"text/plain"},"key":"appkey","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"description":{"content":"mandatory
mandatory
int Filter by channel. Defaults to 14 when no channel is specfifed.
int Filter by charttype
int Filter by trigger id
Filter by url
\n","type":"text/plain"},"key":"url","value":""}],"variable":[]}},"response":[{"id":"575df94d-c203-4942-bbe8-85b697ff4f87","name":"wss_triggers","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"url":{"raw":"https://apisandbox.synthetix.com/2.0/metrics/knowledge/external/wss_triggers?appkey=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&startdate=2023-01-01&enddate=2023-12-31","protocol":"https","host":["apisandbox","synthetix","com"],"path":["2.0","metrics","knowledge","external","wss_triggers"],"query":[{"key":"appkey","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","description":"Application key designating the application whose statistics are being queried."},{"key":"startdate","value":"2023-01-01","description":"`mandatory`"},{"key":"enddate","value":"2023-12-31","description":"`mandatory`"},{"key":"channel","value":"","description":"`int` Filter by channel. Defaults to 14 when no channel is specfifed.","disabled":true},{"key":"charttype","value":null,"description":"`int` Filter by charttype","disabled":true},{"key":"triggerid","value":null,"description":"`int` Filter by trigger id","disabled":true},{"key":"url","value":null,"description":"`int` Filter by url","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 03 May 2024 14:34:06 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"343","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,ETag,Last-Modified,Date,HTTP_X_AMZN_TRACE_ID","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=7776000","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"HTTP_X_AMZN_TRACE_ID","value":"Root=1-6634f5de-1c0ee23c4f2ffd016b3d4977","enabled":true},{"key":"X-API-Node","value":"8e74b1 [Nightly]","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS","enabled":true},{"key":"Expires","value":"2024-05-03T16:24:56+00:00","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n {\n \"001\": \"Synthetix Trigger 1\",\n \"002\": \"Another Trigger\",\n \"410\": \"Out Of Hours\",\n \"678\": \"Backup Trigger\",\n \"947\": \"Synco Init Trigger\"\n }\n]"}],"_postman_id":"748810cb-c278-4cd9-b78f-d207ea04120b"}],"id":"740843de-f930-4a9b-9c16-328b934295eb","_postman_id":"740843de-f930-4a9b-9c16-328b934295eb","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":true,"source":{"_postman_id":"882b98cb-6acf-41d0-89ad-021310c34f6e","id":"882b98cb-6acf-41d0-89ad-021310c34f6e","name":"metrics","type":"folder"}}}],"id":"ca28024b-f20c-45b4-9fc1-2ba992ab4766","_postman_id":"ca28024b-f20c-45b4-9fc1-2ba992ab4766","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":true,"source":{"_postman_id":"882b98cb-6acf-41d0-89ad-021310c34f6e","id":"882b98cb-6acf-41d0-89ad-021310c34f6e","name":"metrics","type":"folder"}}},{"name":"users","item":[{"name":"operators_stats","id":"c95771ae-ec19-44fc-8165-1fdf547e5a3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"url":"https://apisandbox.synthetix.com/2.0/metrics/users/operators_stats?startdate=2023-01-01&enddate=2023-12-31","description":"Returns summarised set of statistics for each active user over the period between the given start date and end date. If no start date or end date are given, the data is restricted to 'today'. Data provided includes user details, reported searches or articles, knowledge searches, article clicks, time online, current status, live chat availability, average response time, average chat duration, satisfaction ratings, comments and feedback. All statistics are aggregated over the selected period. Times are given in seconds.
\n","urlObject":{"protocol":"https","path":["2.0","metrics","users","operators_stats"],"host":["apisandbox.synthetix.com"],"query":[{"key":"startdate","value":"2023-01-01"},{"key":"enddate","value":"2023-12-31"},{"disabled":true,"description":{"content":"Supply a user_id to get stats on a specific user
\n","type":"text/plain"},"key":"user_id","value":""}],"variable":[]}},"response":[{"id":"a6be1d2c-7985-4d4e-899c-d34b71bb408c","name":"operators_stats","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"url":{"raw":"https://apisandbox.synthetix.com/2.0/metrics/users/operators_stats?startdate=2023-01-01&enddate=2023-12-31","protocol":"https","host":["apisandbox.synthetix.com"],"path":["2.0","metrics","users","operators_stats"],"query":[{"key":"startdate","value":"2023-01-01"},{"key":"enddate","value":"2023-12-31"},{"key":"user_id","value":"","description":"Supply a user_id to get stats on a specific user","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 03 May 2024 12:13:15 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"4066","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,ETag,Last-Modified,Date,HTTP_X_AMZN_TRACE_ID","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=7776000","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"HTTP_X_AMZN_TRACE_ID","value":"Root=1-6634d4da-66a1771e42c6751500098673","enabled":true},{"key":"X-API-Node","value":"8e74b1 [Nightly]","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS","enabled":true},{"key":"Expires","value":"2024-05-03T16:24:56+00:00","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n {\n \"avatar\": \"https://cdn.synthetix.com/av_john.jpg\",\n \"name\": \"John Smith\",\n \"nickname\": \"Alastair\",\n \"email\": \"john@synthetix.com\",\n \"user_id\": 0000,\n \"status\": \"offline\",\n \"modules\": [3, 1, 5, 4, 2, 6],\n \"knowledge\": {\n \"articles\": 0,\n \"searches\": 0,\n \"total_searches_percentage\": 0,\n \"total_articles_percentage\": 0,\n \"time_online\": 0,\n \"reported\": {\n \"unresolved\": [],\n \"resolved\": []\n }\n },\n \"livechat\": {\n \"available_with_capacity\": 0,\n \"time_on_max_chats\": 0,\n \"timeline\": {\n \"Available\": 0,\n \"Suspended\": 0\n },\n \"number_pokes\": 0,\n \"time_chat\": 0,\n \"likes\": 0,\n \"chat_history\": [],\n \"capacity\": {\n \"current\": 0,\n \"maximum\": 3\n },\n \"chats\": 0,\n \"total_chats_percentage\": 0,\n \"av_ring_time\": 0,\n \"average_interactions\": 0,\n \"av_chat_time\": 0,\n \"av_wrapup_time\": 0,\n \"group_chats\": 0,\n \"average_response_time\": 0,\n \"satisfaction\": 0,\n \"comments_left\": 0,\n \"comments_left_percentage\": 0,\n \"feedback\": {\n \"3697\": {\n \"Yes\": 0,\n \"No\": 0\n },\n \"3699\": {\n \"4\": 0,\n \"5\": 0,\n \"6\": 0,\n \"7\": 0,\n \"8\": 0,\n \"9\": 0,\n \"10\": 0,\n \"0\": 0,\n \"1\": 0,\n \"2\": 0,\n \"3\": 0\n },\n \"3700\": {\n \"Phone\": 0,\n \"Email/Online\": 0,\n \" Letter\": 0,\n \"Would not\": 0\n }\n },\n \"feedback_submitted\": 0,\n \"feedback_submitted_percentage\": 0,\n \"skipped_feedback\": 0,\n \"skipped_feedback_percentage\": 0,\n \"suspensions\": [],\n \"skills\": [\n {\n \"id\": 422,\n \"skill\": \"Online Customer Service\"\n },\n {\n \"id\": 425,\n \"skill\": \"Live Chat\"\n },\n {\n \"id\": 427,\n \"skill\": \"Technical support\"\n },\n {\n \"id\": 463,\n \"skill\": \"RESTful APIs\"\n },\n {\n \"id\": 428,\n \"skill\": \"Email and Webforms\"\n },\n {\n \"id\": 423,\n \"skill\": \"Web self-service\"\n },\n {\n \"id\": 855,\n \"skill\": \"Accounts\"\n },\n {\n \"id\": 426,\n \"skill\": \"Social Customer Service\"\n },\n {\n \"id\": 429,\n \"skill\": \"Testing\"\n },\n {\n \"id\": 424,\n \"skill\": \"Virtual Agents\"\n }\n ]\n }\n },\n {\n \"avatar\": \"https://cdn.synthetix.com/avatars/luke.jpg\",\n \"name\": \"Brian Potter\",\n \"nickname\": \"Brian\",\n \"email\": \"brian@synthetix.com\",\n \"user_id\": 1111,\n \"status\": \"offline\",\n \"modules\": [1, 5, 2, 6, 3, 4],\n \"knowledge\": {\n \"articles\": 11,\n \"searches\": 0,\n \"total_searches_percentage\": 0,\n \"total_articles_percentage\": 1.06,\n \"time_online\": 435405,\n \"reported\": {\n \"unresolved\": [],\n \"resolved\": []\n }\n },\n \"livechat\": {\n \"available_with_capacity\": 322571,\n \"time_on_max_chats\": 0,\n \"timeline\": {\n \"Available\": 322571,\n \"Suspended\": 112834\n },\n \"number_pokes\": 1,\n \"time_chat\": 7597,\n \"likes\": 0,\n \"chat_history\": [],\n \"capacity\": {\n \"current\": 0,\n \"maximum\": 3\n },\n \"chats\": 9,\n \"total_chats_percentage\": 1.82,\n \"av_ring_time\": 367,\n \"average_interactions\": 3,\n \"av_chat_time\": 969,\n \"av_wrapup_time\": 265,\n \"group_chats\": 0,\n \"average_response_time\": 321,\n \"satisfaction\": 36.5,\n \"comments_left\": 2,\n \"comments_left_percentage\": 22.22,\n \"feedback\": {\n \"3697\": {\n \"Yes\": 0,\n \"No\": 1\n },\n \"3699\": {\n \"4\": 0,\n \"5\": 0,\n \"6\": 1,\n \"7\": 0,\n \"8\": 0,\n \"9\": 0,\n \"10\": 0,\n \"0\": 0,\n \"1\": 0,\n \"2\": 0,\n \"3\": 0\n },\n \"3700\": {\n \"Phone\": 0,\n \"Email/Online\": 0,\n \" Letter\": 0,\n \"Would not\": 1\n }\n },\n \"feedback_submitted\": 2,\n \"feedback_submitted_percentage\": 22.22,\n \"skipped_feedback\": 7,\n \"skipped_feedback_percentage\": 77.78,\n \"suspensions\": [],\n \"skills\": [\n {\n \"id\": 426,\n \"skill\": \"Social Customer Service\"\n },\n {\n \"id\": 429,\n \"skill\": \"Testing\"\n },\n {\n \"id\": 428,\n \"skill\": \"Email and Webforms\"\n },\n {\n \"id\": 424,\n \"skill\": \"Virtual Agents\"\n }\n ]\n }\n },\n {\n \"avatar\": \"https://cdn.synthetix.com/patty.jpg\",\n \"name\": \"Patty Burger\",\n \"nickname\": \"Pat\",\n \"email\": \"patty@synthetix.com\",\n \"user_id\": 3333,\n \"status\": \"offline\",\n \"modules\": [5, 3, 1, 2, 6, 4],\n \"knowledge\": {\n \"articles\": 0,\n \"searches\": 0,\n \"total_searches_percentage\": 0,\n \"total_articles_percentage\": 0,\n \"time_online\": 0,\n \"reported\": {\n \"unresolved\": [],\n \"resolved\": []\n }\n },\n \"livechat\": {\n \"available_with_capacity\": 0,\n \"time_on_max_chats\": 0,\n \"timeline\": {\n \"Available\": 0,\n \"Suspended\": 0\n },\n \"number_pokes\": 0,\n \"time_chat\": 0,\n \"likes\": 0,\n \"chat_history\": [],\n \"capacity\": {\n \"current\": 0,\n \"maximum\": 2\n },\n \"chats\": 0,\n \"total_chats_percentage\": 0,\n \"av_ring_time\": 0,\n \"average_interactions\": 0,\n \"av_chat_time\": 0,\n \"av_wrapup_time\": 0,\n \"group_chats\": 0,\n \"average_response_time\": 0,\n \"satisfaction\": 0,\n \"comments_left\": 0,\n \"comments_left_percentage\": 0,\n \"feedback\": {\n \"3697\": {\n \"Yes\": 0,\n \"No\": 0\n },\n \"3699\": {\n \"4\": 0,\n \"5\": 0,\n \"6\": 0,\n \"7\": 0,\n \"8\": 0,\n \"9\": 0,\n \"10\": 0,\n \"0\": 0,\n \"1\": 0,\n \"2\": 0,\n \"3\": 0\n },\n \"3700\": {\n \"Phone\": 0,\n \"Email/Online\": 0,\n \" Letter\": 0,\n \"Would not\": 0\n }\n },\n \"feedback_submitted\": 0,\n \"feedback_submitted_percentage\": 0,\n \"skipped_feedback\": 0,\n \"skipped_feedback_percentage\": 0,\n \"suspensions\": [],\n \"skills\": [\n {\n \"id\": 429,\n \"skill\": \"Testing\"\n },\n {\n \"id\": 424,\n \"skill\": \"Virtual Agents\"\n },\n {\n \"id\": 427,\n \"skill\": \"Technical support\"\n },\n {\n \"id\": 463,\n \"skill\": \"RESTful APIs\"\n },\n {\n \"id\": 422,\n \"skill\": \"Online Customer Service\"\n },\n {\n \"id\": 425,\n \"skill\": \"Live Chat\"\n },\n {\n \"id\": 428,\n \"skill\": \"Email and Webforms\"\n },\n {\n \"id\": 855,\n \"skill\": \"Accounts\"\n },\n {\n \"id\": 423,\n \"skill\": \"Web self-service\"\n },\n {\n \"id\": 426,\n \"skill\": \"Social Customer Service\"\n }\n ]\n }\n }\n]"}],"_postman_id":"c95771ae-ec19-44fc-8165-1fdf547e5a3a"}],"id":"f39838d7-77cd-461e-9b85-30a4925f5f9f","_postman_id":"f39838d7-77cd-461e-9b85-30a4925f5f9f","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":true,"source":{"_postman_id":"882b98cb-6acf-41d0-89ad-021310c34f6e","id":"882b98cb-6acf-41d0-89ad-021310c34f6e","name":"metrics","type":"folder"}}},{"name":"downloads","item":[{"name":"directory","id":"384ae3ff-3c70-45c7-8302-5fbd64868056","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"DELETE","header":[{"description":"\n","key":"APPLICATIONKEY","value":"your-application-key"},{"description":"\n","key":"CONSUMERKEY","value":"your-consumer-key"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"xxxxxxx.csv","type":"text"},{"key":"job","value":"df-xxxxx","type":"text"}]},"url":"https://apisandbox.synthetix.com/2.0/metrics/downloads/directory","description":"Provide a job number and file name to delete it from the data warehouse. This cannot be undone.
\n","urlObject":{"protocol":"https","path":["2.0","metrics","downloads","directory"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"e5a4ead9-7b8b-4aac-9aba-2a8a0c05e3f9","name":"directory","originalRequest":{"method":"DELETE","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"xxxxxxxxxcsv","type":"text"},{"key":"job","value":"df-xxxxx","type":"text"}]},"url":"https://apisandbox.synthetix.com/2.0/metrics/downloads/directory"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Jun 2019 13:26:19 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"36","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified,Date","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-API-Node","value":"d0203a (Mon, 17 Jun 2019 15:27:31)","enabled":true},{"key":"X-API-Version","value":"Dev;(D3)","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,DELETE,OPTIONS","enabled":true},{"key":"Expires","value":"2019-06-18T14:13:56+00:00","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"384ae3ff-3c70-45c7-8302-5fbd64868056"},{"name":"directory","id":"71545a6d-1272-4b84-9602-e14b8632c5fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"description":"\n","key":"APPLICATIONKEY","value":"your-application-key"},{"description":"\n","key":"CONSUMERKEY","value":"your-consumer-key"}],"url":"https://apisandbox.synthetix.com/2.0/metrics/downloads/directory","description":"Returns a list of all data downloads with a http link to the csv file. This can be used to periodically crawl and download report into a data warehouse.
\n","urlObject":{"protocol":"https","path":["2.0","metrics","downloads","directory"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"e1fb5a84-aef7-466c-8c8c-6000aaee7956","name":"directory","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"url":"https://apisandbox.synthetix.com/2.0/metrics/downloads/directory"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 18 Jun 2019 13:14:51 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"3339","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified,Date","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-API-Node","value":"d0203a (Mon, 17 Jun 2019 15:27:31)","enabled":true},{"key":"X-API-Version","value":"Dev;(D3)","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,DELETE,OPTIONS","enabled":true},{"key":"Expires","value":"2019-06-18T14:13:56+00:00","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"{\r\n \"df-00012981LQJZQVIPC7EI\": [\r\n {\r\n \"name\": \"report.csv\",\r\n \"time\": \"2018-09-03 15:03:08\",\r\n \"size\": 2050,\r\n \"location\": \"https://synthetix-enhanced-data-download-processed.s3.amazonaws.com/xxxxxxxxxxxxxxxx\",\r\n \"timestamp\": 1535986988\r\n },\r\n {\r\n \"name\": \"test.csv\",\r\n \"time\": \"2018-09-03 14:51:39\",\r\n \"size\": 70517,\r\n \"location\": \"https://synthetix-enhanced-data-download-processed.s3.amazonaws.com/xxxxxxxxxxxxxxxx\",\r\n \"timestamp\": 1535986299\r\n }\r\n ]\r\n}"}],"_postman_id":"71545a6d-1272-4b84-9602-e14b8632c5fe"}],"id":"abe899a7-8b37-4c34-9bb8-6b039795a1c3","_postman_id":"abe899a7-8b37-4c34-9bb8-6b039795a1c3","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":true,"source":{"_postman_id":"882b98cb-6acf-41d0-89ad-021310c34f6e","id":"882b98cb-6acf-41d0-89ad-021310c34f6e","name":"metrics","type":"folder"}}}],"id":"882b98cb-6acf-41d0-89ad-021310c34f6e","description":"Metrics endpoints offer a diverse range of metric data to retreive. Users can access live chat summaries, article histories, and user statistics effortlessly. These endpoints give users valuable insights into their useage of our services.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"7206b7f1-5f06-4936-ac77-a0e380775d6a"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"8e0b9fee-a881-4d9e-87cc-c57e4f4147e9"}}],"_postman_id":"882b98cb-6acf-41d0-89ad-021310c34f6e"},{"name":"internal","item":[{"name":"chatids","id":"8cb1c14f-5e82-43e1-b972-e77b2c7ef323","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"url":"https://apisandbox.synthetix.com/2.0/internal/chatids?skill=skill&status=a&startdate=2023-01-01&enddate=2023-12-31","description":"Returns an array of uniqRef chat ids
\n","urlObject":{"protocol":"https","path":["2.0","internal","chatids"],"host":["apisandbox.synthetix.com"],"query":[{"description":{"content":"blank = all skills
\n","type":"text/plain"},"key":"skill","value":"skill"},{"description":{"content":"a = abandoned, m = missed, c = completed (blank = everything)
\n","type":"text/plain"},"key":"status","value":"a"},{"key":"startdate","value":"2023-01-01"},{"key":"enddate","value":"2023-12-31"}],"variable":[]}},"response":[{"id":"00c9cf71-49ab-47fc-8646-63c227eb25d8","name":"chatids","originalRequest":{"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"url":{"raw":"https://apisandbox.synthetix.com/2.0/internal/chatids?startdate=2023-01-01&enddate=2023-12-31","protocol":"https","host":["apisandbox","synthetix","com"],"path":["2.0","internal","chatids"],"query":[{"key":"skill","value":"skill","description":"blank = all skills","disabled":true},{"key":"status","value":"a","description":"a = abandoned, m = missed, c = completed (blank = everything)","disabled":true},{"key":"startdate","value":"2023-01-01"},{"key":"enddate","value":"2023-12-31"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 03 May 2024 08:10:48 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,ETag,Last-Modified,Date,HTTP_X_AMZN_TRACE_ID","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=7776000","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"HTTP_X_AMZN_TRACE_ID","value":"Root=1-66349c08-00ea27124d4d6b3f296aed83","enabled":true},{"key":"X-API-Node","value":"8e74b1 [Nightly]","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,OPTIONS","enabled":true},{"key":"Expires","value":"2024-05-03T14:10:01+00:00","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n \"AaCcDdFfGgHhO\",\n \"CcFfAaHhDdGgO\",\n \"DdFfGgCcaOoHh\",\n \"HhGgFfDdcOoAa\",\n \"GgFfCcAaoDdHh\",\n \"OoCcHhDdgFfAa\",\n \"AaGgCcFfdHhOo\",\n \"DdCcHhAafGgOo\",\n \"FfDdAaHhgCcOo\",\n \"CcDdOoAagFfHh\",\n \"HhAaGgCcfDdOo\"\n]"}],"_postman_id":"8cb1c14f-5e82-43e1-b972-e77b2c7ef323"},{"name":"session","event":[{"listen":"test","script":{"id":"680cae46-97ce-42b5-9f29-8a887885613c","exec":[""],"type":"text/javascript","packages":{}}}],"id":"a51d61e6-f39c-4073-9312-49941b56bd97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"}],"body":{"mode":"formdata","formdata":[{"key":"username","value":"username","description":"mandatory
mandatory
Initate an internal session for a service account. The token value returned is the Bearer token required for authentication.
\n","urlObject":{"protocol":"https","path":["2.0","internal","session"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"a4ebef92-84ac-487a-bfbd-2c62683b78ba","name":"session","originalRequest":{"method":"POST","header":[{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"CONSUMERKEY","value":"your-consumer-key"},{"key":"","value":"","type":"text","disabled":true},{"key":"Content-Type","value":"","disabled":true}],"body":{"mode":"formdata","formdata":[{"key":"username","value":"your-synthetix-username","description":"`mandatory`","type":"text"},{"key":"password","value":"your-synthetix-password","description":"`mandatory`","type":"text"}]},"url":"https://apisandbox.synthetix.com/2.0/internal/session"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Methods","value":"GET,POST,DELETE,PATCH,OPTIONS","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,X-API-Environment,X-API-Version,ETag,Last-Modified","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Date","value":"Wed, 24 Oct 2018 11:42:50 GMT","enabled":true},{"key":"Expires","value":"GMT","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-API-Node","value":"52c20b7818fd","enabled":true},{"key":"X-API-Version","value":"development;(D3)","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Quota","value":"unlimited/infinite","enabled":true},{"key":"X-Request-ID","value":"1540381370-1705158265-27","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Content-Length","value":"68","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"authorised\": true,\n \"token\": \"xxxxxxx-xxxx-xxxx-xxxx-xxxxxxx\",\n \"days_until_password_expires\": 10\n}"}],"_postman_id":"a51d61e6-f39c-4073-9312-49941b56bd97"}],"id":"f0931432-66a3-4452-a6ee-c2c9d3958bdb","description":"Internal endpoints encompass functionalities such as retreiving chat ids and initialising a new session.
\n","_postman_id":"f0931432-66a3-4452-a6ee-c2c9d3958bdb"},{"name":"livechat","item":[{"name":"details","id":"a5588311-97ba-437f-9aac-d8d196a96072","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"POST","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"body":{"mode":"formdata","formdata":[{"key":"uniQref","value":"your_uniqRef","description":"mandatory. Can be an array of chat reference IDs
true or talse. false as default if not passed. \nWill return up to 10 previous chats per uniQref provided if there is a match on telephone number or email address.
\n","type":"text"}]},"url":"https://apisandbox.synthetix.com/2.0/livechat/details","description":"Returns the chat information of the passed uniQref ID.
\n","urlObject":{"protocol":"https","path":["2.0","livechat","details"],"host":["apisandbox.synthetix.com"],"query":[],"variable":[]}},"response":[{"id":"140709e9-1a09-476b-a39d-c577b02e8c5b","name":"details","originalRequest":{"method":"POST","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"[Learn more...](#authentication)"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"[Learn more...](#authentication)"}],"body":{"mode":"formdata","formdata":[{"key":"uniQref","value":"your_uniqRef","description":"`mandatory`. Can be an array of chat reference IDs","type":"text"},{"key":"previous_contact","value":"true","description":"true or talse. false as default if not passed. \nWill return up to 10 previous chats per uniQref provided if there is a match on telephone number or email address.","type":"text"}]},"url":"https://apisandbox.synthetix.com/2.0/livechat/details"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 May 2024 15:14:34 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"1567","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"Apache","enabled":true},{"key":"Access-Control-Allow-Headers","value":"Authorization,APPLICATIONKEY,CONSUMERKEY,HTTP_X_FORWARDED_FOR,CONTENT-TYPE","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Expose-Headers","value":"X-API-Node,ETag,Last-Modified,Date,HTTP_X_AMZN_TRACE_ID","enabled":true},{"key":"Cache-Control","value":"no-cache,no-store,must-revalidate","enabled":true},{"key":"Accept","value":"application/json,multipart/form-data,application/x-www-form-urlencoded","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Tk","value":"N","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=7776000","enabled":true},{"key":"X-Cake","value":"The Cake is a lie","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"HTTP_X_AMZN_TRACE_ID","value":"Root=1-6633add9-5d33cf2131bb0a8b2d5f9dfe","enabled":true},{"key":"X-API-Node","value":"8e74b1 [Nightly]","enabled":true},{"key":"Access-Control-Allow-Methods","value":"POST,PATCH,OPTIONS","enabled":true},{"key":"Expires","value":"2024-05-02T16:11:05+00:00","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"ABDEFGH\": {\n \"participants\": [\n {\n \"user_id\": \"0000\",\n \"Name\": \"Jenny Smith\",\n \"avatar\": \"https://cdn.synthetix.com/av.jpg\"\n }\n ],\n \"status\": \"Completed\",\n \"current_status\": \"Completed\",\n \"email\": \"jen.smith@synthetix.com\",\n \"phone\": \"3323213213123\",\n \"skill\": \"Online Customer Service\",\n \"channel\": \"Live chat\",\n \"op_name\": \"JenSmith\",\n \"application\": \"ABC38848DEF93\",\n \"uniQref\": \"ABDEFGH\",\n \"name\": \"Jenny Smith\",\n \"start_time\": \"2024-05-02 16:11:36\",\n \"accept_time\": \"2024-05-02 16:11:41\",\n \"finish_time\": \"2024-05-02 16:14:20\",\n \"wrap_up_time\": \"2024-05-02 16:14:23\",\n \"misc\": \"\",\n \"brand\": \"\",\n \"ipaddress\": \"00.000.000.000\",\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:125.0) Gecko/20100101 Firefox/125.0\",\n \"source\": \"https://cdn.synthetix.com/penfield/svelte/widget/index.html\",\n \"Geo\": \"00.0000,00.0000\",\n \"owner_id\": 0000,\n \"session\": \"000-0000-0000-0000-000000000000\",\n \"PreviousContact\": [\n {\n \"uniQref\": \"AABBCCDDEEFF\",\n \"start_time\": \"2024-02-15 14:22:28\",\n \"name\": \"Jenny Smith\",\n \"surname\": \"Smith\",\n \"skill\": \"Testing\",\n \"phone\": \"2313213\",\n \"misc\": \"\",\n \"email\": \"jen.smith@synthetix.com\",\n \"operator\": 00000,\n \"status\": \"Completed\",\n \"current_status\": \"Completed\",\n \"channel\": \"Live chat\",\n \"transcript_sent\": false,\n \"banned\": false,\n \"flagged\": false\n }\n \n ],\n \"likes\": 0,\n \"banned\": false,\n \"flagged\": false,\n \"last_ping_seconds\": 8,\n \"last_ping_timestamp\": 1714662865,\n \"environmental\": {\n \"channel\": \"0\"\n },\n \"queue\": 5,\n \"duration\": 159,\n \"trigger\": \"inknowledgelivechat\",\n \"what_3_words\": {\n \"words\": \"what.three.words\",\n \"map\": \"https://map.what3words.com/what.three.words\"\n },\n \"feedback\": {\n \"operator\": {\n \"189\": \"faqtAgent enquiry\",\n \"190\": \"Yes\",\n \"344\": \"test\"\n },\n \"customer\": []\n },\n \"end_reason\": \"Operator Ended Chat\",\n \"transcript_status\": \"Not Sent\",\n \"Messages\": [\n [\n {\n \"type\": \"message\",\n \"messageIndex\": 0,\n \"subject\": \"727823555f2b37077040\",\n \"id\": \"998877665544\",\n \"score\": 0,\n \"ReceivedAt\": \"02/05/2024 16:11:41\",\n \"Sender\": \"Agent\",\n \"Name\": \"Jenny Smith\",\n \"Message\": \"Hello, how can I help you today?\",\n \"status\": 2,\n \"user_id\": 0000,\n \"Attachments\": \"\",\n \"profileimage\": null\n }\n ]\n ],\n \"Message Count\": 1\n }\n}"}],"_postman_id":"a5588311-97ba-437f-9aac-d8d196a96072"},{"name":"queue","id":"46d174ea-5488-462a-bed1-33c362e65af1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your-synthetix-token"}]},"isInherited":false},"method":"GET","header":[{"key":"APPLICATIONKEY","value":"your-application-key","description":"\n"},{"key":"CONSUMERKEY","value":"your-consumer-key","description":"\n"}],"url":"https://apisandbox.synthetix.com/2.0/livechat/queue","description":"Retrieves a list of all chats currently in the queue. Access to this endpoint requires a service account.
\nThe response includes detailed information about each chat, such as:
\nuniQref: The chat's unique reference ID.
skill: The assigned skill of the chat.
bump: Indicates whether the chat has been escalated or transferred to a different skill, giving it higher priority.
state: The current status of the chat, represented by:
\"N\": New
\"O\": Open
\"U\": Updated
\"C\": Closed
Live chat endpoints provide the ability to retreive live chat data, enabling the extraction of comprehensive details for analysis, monitoring, and record-keeping purposes.
\n","_postman_id":"1b806108-74b0-403d-b4f5-15fe6db30d56"}],"event":[{"listen":"prerequest","script":{"id":"9804ae4c-58e6-4bdd-81bf-dd0e8e6b313d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"71ba92d4-67d8-40b0-a398-bcb4601eab47","type":"text/javascript","exec":[""]}}],"variable":[{"key":"TOKEN","value":"your-synthetix-token"},{"key":"CONSUMERKEY","value":"your-consumer-key"},{"key":"APPLICATIONKEY","value":"your-application-key"},{"key":"HOST","value":"apisandbox.synthetix.com"},{"key":"BASE","value":"2.0"}]}