Khoros Reports API
The Reports API from Khoros — 16 operation(s) for reports.
Operations 18
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“How do I check whether my older Care report job has finished?”
“Is the reports jobs status endpoint being deprecated?”
Tell an agent
Check the status of my report jobs on the legacy jobs endpoint.
Tell me if my pending Care analytics job is done yet.
GET
/reports/report/conversation_actions
Generate a conversation actions report via GET · Create conversation actions report
#
Ask an LLM
“How do I pull a conversation actions report with query parameters only?”
“Can I filter a conversation actions report to certain work queues?”
Tell an agent
Generate a conversation actions report for company {companyKey} from {startTime} to {endTime} via query string.
Run the GET conversation actions report for {companyKey} limited to work queues {workqueueIds}.
POST
/reports/report/conversation_actions
Generate a conversation actions export via POST · Create conversation actions export
#
Ask an LLM
“Can I send conversation actions export settings in a JSON body instead of the URL?”
“What options does the POSTed conversation actions export accept, like business hours?”
Tell an agent
Start a conversation actions export for {companyKey} with body start {startTime} and end {endTime}.
POST a conversation actions export for {companyKey} in format {reportFormat}.
Ask an LLM
“How do I export agent user data with a simple GET request?”
“Can a user export include disabled users?”
Tell an agent
Generate a user export for {companyKey} from {startTime} to {endTime} using query parameters.
Export users for team {teamId} in {companyKey} via GET, including disabled ones {includeDisabled}.
Ask an LLM
“Can I request a user export with the settings in a request body?”
“Is it possible to export just one agent's user data with a POSTed body?”
Tell an agent
POST a user export for {companyKey} with body start {startTime} and end {endTime}.
Start a body-based user export for agent {agentId} in {companyKey}.
GET
/reports/report/{workflowId}/{runId}/download
Download a finished Care export · Download export by run ID
#
Ask an LLM
“How do I download an export once its run has completed?”
“Where do I get the file for a finished report run?”
Tell an agent
Download the export for workflow {workflowId} run {runId}.
Fetch the completed report file from run {runId} of workflow {workflowId}.
Ask an LLM
“How do I export raw data about the authors who contacted us?”
“Can a raw author export be limited to business hours?”
Tell an agent
Create a raw author export for {companyKey} from {startTime} to {endTime}.
Export raw author data for {companyKey} in time zone {timezone}.
Ask an LLM
“Is there a single export that combines raw conversation data sets?”
“How do I get the raw combined export for a date range?”
Tell an agent
Create a raw combined export for {companyKey} covering {startTime} to {endTime}.
Run the raw combined export for {companyKey} filtered to priorities {priorities}.
POST
/reports/report/conversation
Generate a raw conversations export · Create raw conversations export
#
Ask an LLM
“How do I export raw conversation records for a time range?”
“Can I choose a conversation report type in the raw conversations export?”
Tell an agent
Create a raw conversations export for {companyKey} from {startTime} to {endTime}.
Export raw conversations for {companyKey} of type {conversationReportType}.
POST
/reports/report/conversation_history_action
Generate a conversation action history export · Create conversation action history export
#
Ask an LLM
“How do I export the history of actions taken on conversations?”
“Can I raise the row limit on a conversation action history export?”
Tell an agent
Create a conversation action history export for {companyKey} from {startTime} to {endTime}.
Export conversation action history for {companyKey} with the raised limit {raiselimit}.
POST
/reports/report/incoming_post
Generate a raw incoming post export · Create raw incoming post export
#
Ask an LLM
“How do I export every inbound post we received in a period?”
“Can the raw incoming post export be restricted to a smart view?”
Tell an agent
Create a raw incoming post export for {companyKey} from {startTime} to {endTime}.
Export incoming posts for {companyKey} in smart view {smartViewId}.
Ask an LLM
“How do I export when agents were available, busy or away?”
“Can an agent state export be limited to certain teams?”
Tell an agent
Create an agent state export for {companyKey} from {startTime} to {endTime}.
Export agent states for teams {teamIds} in {companyKey}.
POST
/reports/report/raw_expert_help
Generate a raw help request export · Create raw help request export
#
Ask an LLM
“How do I export the help requests agents sent to experts?”
“Which date range does the raw help request export cover?”
Tell an agent
Create a raw help request export for {companyKey} from {startTime} to {endTime}.
Export expert help requests for {companyKey} in locale {locale}.
Ask an LLM
“How do I export every response agents sent to customers?”
“Can a raw response export be filtered by work queue?”
Tell an agent
Create a raw response export for {companyKey} from {startTime} to {endTime}.
Export agent responses for {companyKey} in work queues {workqueueIds}.
POST
/reports/report/response_approval
Generate a raw response approval export · Create raw response approval export
#
Ask an LLM
“How do I export which agent responses went through approval?”
“Can a response approval export include disabled users?”
Tell an agent
Export which agent replies went through approval for {companyKey} between {startTime} and {endTime}.
Export response approvals for {companyKey} including disabled users {includeDisabled}.
POST
/reports/report/team_performance
Generate a raw team performance export · Create raw team performance export
#
Ask an LLM
“How do I export performance numbers for my support teams?”
“Can a team performance export cover only selected teams?”
Tell an agent
Create a raw team performance export for {companyKey} from {startTime} to {endTime}.
Export team performance for teams {teamIds} in {companyKey}.
POST
/reports/report/team_performance_interval
Run a team performance interval export · Run team performance interval export
#
Ask an LLM
“Can I break team performance down into fixed time intervals?”
“Is the time interval required for the team performance interval export?”
Tell an agent
Run a team performance interval export for {companyKey} at interval {timeInterval} from {startTime} to {endTime}.
Export team performance in {timeInterval} buckets for {companyKey}.
POST
/reports/report/{report_type}
Run a Care Analytics report by type · Run care analytics report
#
Ask an LLM
“How do I run any Care Analytics report by naming its report type?”
“Which report types can I run through the generic Care Analytics report call?”
Tell an agent
Run Care Analytics report {report_type} for {companyKey} from {startTime} to {endTime}.
Run the {report_type} analytics report for {companyKey} in format {reportFormat}.
Documentation
📖
Documentation
https://developer.khoros.com/khoroscaredevdocs/docs/khoros-care-integration-overview
📖
Documentation
https://developer.khoros.com/khorosmarketingdevdocs/docs/developing-and-integrating-with-khoros-marketing
📖
Documentation
https://developer.khoros.com/khoros-flow/docs/overview-of-khoros-flow-apis