Request Report Generation

post

https://api.lodgestory.com/api/wp-crm/reports/{organisationId}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

organisationId

string

required

Body Params

reportType

string

enum

required

Allowed:

isArchived

boolean

isResolved

boolean

isHighPriority

boolean

isBotHandled

boolean

unanswered

boolean

hasAssignees

boolean

isAgentTransferred

boolean

isBotSessionClosed

boolean

assignedToUserIds

array of strings

assignedToUserIds

assignedToTeamIds

array of strings

assignedToTeamIds

isPrimaryAssignee

boolean

hasNoPrimaryAssignee

boolean

hasContacts

boolean

contactSearch

string

stateMachineIds

array of strings

stateMachineIds

currentStateIds

array of strings

currentStateIds

hasStateMachine

boolean

chatNameSearch

string

chatType

string

channelIds

array of strings

channelIds

updatedAfter

string

updatedBefore

string

labelIds

array of strings

labelIds

hasLabels

boolean

allLabelIds

array of strings

allLabelIds

contactReportSearch

string

contactChannelIds

array of strings

contactChannelIds

contactHasChats

boolean

contactCreatedAfter

string

contactCreatedBefore

string

contactCreatedByUserIds

array of strings

contactCreatedByUserIds

contactCustomFilters

string

ticketIsResolved

boolean

ticketPriorityLevels

array of strings

ticketPriorityLevels

ticketAssignedToUserIds

array of strings

ticketAssignedToUserIds

ticketCreatedByUserIds

array of strings

ticketCreatedByUserIds

ticketMachineIds

array of strings

ticketMachineIds

ticketCreatedAfter

string

ticketCreatedBefore

string

ticketSearch

string

callDirection

string

callStatuses

array of strings

callStatuses

callAgentUserIds

array of strings

callAgentUserIds

callAccountId

string

callFromDate

string

callToDate

string

callPhoneSearch

string

callHasChat

boolean

callHasRecording

boolean

callMinDuration

number

callMaxDuration

number

callHangupCause

string

callContactSearch

string

goalFromDate

string

goalToDate

string

goalIds

array of strings

goalIds

goalChannelIds

array of strings

goalChannelIds

goalTrackerFilters

string

Responses

401

Unauthorized — invalid/expired JWT or organisation ID does not match the token

403

Forbidden — user does not have CRM_ADMIN or ACCOUNT_OWNER role

409

A report of this type is already being generated or was recently completed. Wait 5 minutes between requests of the same type.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Report generation started