Developer DiscussionDeveloper BlogAtlas
API Reference
  1. Analytics Reports

Create conversation actions export

post
https://analytics-api.app.lithium.com/api/public/reports/report/conversation_actions

Generate a Conversation Actions export

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Details

🚧

WARNING

The URL for Care Analytics depends on your regional location. Please refer to the Analytics Reports API Reference Overview for more information.

Added July 2019

Runs a Conversation Actions export. See Analytics Reports API quickstart for more details.

👍

Tip

You may also generate this export using GET /reports/report/conversation_actions; however, POST is the recommended method. When you generate the export using GET, pass all parameters as query string parameters.

🚧

Important

Pass all parameters except for companyKey in the request body. Pass companyKey as a query parameter. See the example for the correct format.

All fields in exports are of the datatype String and have a field length of unbounded. Times will be formatted per the Company setting OR the Locale that the user specifies when running the export.

All arguments are case-sensitive.

The workflowId and the runId in the response are unique IDs specific to this export job. The IDs are used by the /reports/report/workflowId/runId/status and /reports/report/workflowId/runId/download endpoints to check the status of an export job and to download it.

Make a GET request to the /reports/report/<workflowId>/<runId>/status endpoint as shown in the statusUrl field to check the status of the job. When the result.runnerState is CLOSED and result.detail is COMPLETED in the response to /reports/report/<workflowId>/<runId>/status, you are ready to run the endpoint in the downloadUrl. An empty value for downloadUrl indicates that the export has not ready.

Make a GET request to the /reports/report/workflowId/runId/download endpoint as shown in the downloadUrl field to download the export locally.

See Using timezone with timezoneOffset when making a request with these parameters.

See Define columns to return in an export to learn how to specify a limited set of columns to return in the export.

Query Params
string
required

The company key found in Account Admin > General Settings > Analytics API Settings.

Body Params
boolean

Sets the business hour type. true means “within business hours”, false means “outside of business hours”, and null/missing means “No Business Hours, aka 24/7”.

If you pass in a non-null value for businessHourType, you must also pass in enableBusinessHour=true.

Learn more about business hours in Business hours in Response.

boolean
Defaults to false

Enables filtering by business hours using the businessHourType parameter. If you pass in a non-null value for businessHourType, you must also pass in enableBusinessHour=true. Learn more about business hours in Business hours in Response

If the Smart View specified by the smartViewId parameter uses business hours, the smart view’s settings (as defined in Response’s Admin screen) for business hours overrides both enableBusinessHour and businessHourType.

string
required

The end time in epoch milliseconds. This value will not be adjusted.

string

The locale to use for the export. Supported values: en, es, fr, de, tr

string

Filters the export to only data (posts or conversations) that match the specified priority.

Pass a comma-separated list with values 0 through 5. The list must be URL-encoded. For example: priorities=0%2C1%2C2%2C3%2C4%2C5

If not specified, all priorities are included.

string
Defaults to json

The format of the export. Possible values: json or csv. Default is json.

Prior to the February 2019 release, only the Agent State Export, Raw Brand Post Export, Raw Expert Help Request, Raw Response, Raw Team Performance, and Team Performance Interval reports were available in JSON format.

string

Added December 2018. Use reportMetrics to return specific metrics (columns) in the export. You can use this to return a subset of metrics and also to return metrics currently disabled for your company. Use a separate reportMetrics query parameter for each metric desired.

Example: reportMetrics=agent_name&reportMetrics=agent_email&reportMetrics=agent_id

string

Filters the export to only data (posts or conversations) that match the specified smart view. You must use the ID of the smart view for this parameter. Use /api/v2/smartviews to find IDs for your existing smart view. Note: Only one smart view ID can be passed in as a parameter.

string
required

The start time in epoch milliseconds. This value will not be adjusted.

string

A time zone ID to specify in which time zone to format dates in the export. Find supported time zone IDs using the /config/timezones endpoint.

string

Pass the timezone offset in milliseconds to calculate and format dates in the export to this offset.

If not provided, then times will be in UTC (Coordinated Universal Time).

This is only used to format dates, and is not aware of changes to/from Daylight Saving Time.

Use Positive values for timezones ahead of UTC and negative values for timezones behind UTC.

Examples:
A timezone that is UTC +01:00 should send in a timezoneOffset of 3600000.
A timezone that is UTC -01:00 should send in a timezoneOffset of -3600000.

string

Filters the export to only data (posts or conversations) that match the specified work queue.

You must use the ID of the work queue for this parameter. Use /api/v2/workqueues/active to find IDs for your existing work queues.

Pass a comma-separated list of the IDs. The list must be URL-encoded. For example: workqueueIds=15%2C21%2C2%2C23%2C52%2C13

Response

Updated about 1 year ago

Language
LoadingLoading…
Response
Choose an example:
text/plain

Updated about 1 year ago