Request Report Generation

post

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

Request generation of a CRM report for your organisation.

Supported report types:

Type	Description
`CHAT`	All chats with filters for assignees, labels, priority, bot status, date range, etc.
`CONTACT`	Contact records with filters for search, channels, creation date, custom fields
`TICKET`	Tickets with filters for resolution status, priority, assignees, date range
`CALL_LOG`	Call logs with filters for direction, status, agents, duration, date range
`GOAL`	Goal events with filters for date range, goal IDs, channels, tracker values

Required steps before calling:

Obtain a JWT via POST /api/wp-crm/token
Choose a reportType and optionally add filter fields to narrow the report scope

Security:

The organisationId in the URL path must match the organisation your JWT was issued for. The token is cryptographically bound to a specific organisation — requests targeting a different organisation will fail with 401 Unauthorized.
Only users with CRM_ADMIN or ACCOUNT_OWNER role in the organisation can request reports. Other roles will receive a 403 Forbidden.

Rate limiting: Only one report per type per organisation can be generated every 5 minutes. If a report is already being generated or was recently completed, you'll receive a 409 Conflict.

Returns a report record with status PENDING. Poll GET /api/wp-crm/reports/:organisationId to check when it completes, then use the download endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

organisationId

string

required

Your organisation UUID (returned as org from the /token endpoint)

Body Params

reportType

string

enum

required

Type of report to generate

Allowed:

isArchived

boolean

Filter by archived status

isResolved

boolean

Filter by resolved/closed status. Omitted/false = only open chats; true = only resolved/closed chats.

isHighPriority

boolean

Filter by high priority status

isBotHandled

boolean

Filter chats handled by bot (autopilot OR active bot journey)

unanswered

boolean

Filter unanswered chats (last message from guest)

hasAssignees

boolean

Filter by assignee presence (true=assigned, false=unassigned)

isAgentTransferred

boolean

Filter chats with active agent-transferred bot session

isBotSessionClosed

boolean

Filter chats with closed/completed bot session

assignedToUserIds

array of strings

Filter chats assigned to specific user IDs

assignedToUserIds

assignedToTeamIds

array of strings

Filter chats assigned to specific team IDs

assignedToTeamIds

isPrimaryAssignee

boolean

Filter by primary assignee status

hasNoPrimaryAssignee

boolean

Filter chats with no primary assignee

hasContacts

boolean

Filter chats that have contacts attached

contactSearch

string

Search contacts by name or phone

stateMachineIds

array of strings

Filter by specific state machine IDs

stateMachineIds

currentStateIds

array of strings

Filter by current state IDs

currentStateIds

hasStateMachine

boolean

Filter chats that have state machines attached

chatNameSearch

string

Fuzzy search across chat names, external items, and contact names

chatType

string

Filter by chat type

channelIds

array of strings

Filter by specific channel IDs

channelIds

updatedAfter

string

Filter chats updated after this date (ISO string)

updatedBefore

string

Filter chats updated before this date (ISO string)

labelIds

array of strings

Filter chats that have any of these label IDs (OR logic)

labelIds

hasLabels

boolean

Filter chats that have labels attached

allLabelIds

array of strings

Filter chats that have ALL of these label IDs (AND logic)

allLabelIds

contactReportSearch

string

Search contacts by name, phone, or email (CONTACT report)

contactChannelIds

array of strings

Filter contacts by channel IDs (CONTACT report)

contactChannelIds

contactHasChats

boolean

Filter contacts that have linked chats (CONTACT report)

contactCreatedAfter

string

Filter contacts created after this date (CONTACT report)

contactCreatedBefore

string

Filter contacts created before this date (CONTACT report)

contactCreatedByUserIds

array of strings

Filter contacts created by specific user IDs (CONTACT report)

contactCreatedByUserIds

contactCustomFilters

string

JSON-encoded array of custom field filter rules for CONTACT reports. Each rule: { field, operator, value }.

ticketIsResolved

boolean

Filter tickets by resolution status (TICKET report)

ticketPriorityLevels

array of strings

Filter tickets by priority levels (TICKET report)

ticketPriorityLevels

ticketAssignedToUserIds

array of strings

Filter tickets by assigned user IDs (TICKET report)

ticketAssignedToUserIds

ticketCreatedByUserIds

array of strings

Filter tickets by creator user IDs (TICKET report)

ticketCreatedByUserIds

ticketMachineIds

array of strings

Filter tickets by ticketing machine IDs (TICKET report)

ticketMachineIds

ticketCreatedAfter

string

Filter tickets created after this date (TICKET report)

ticketCreatedBefore

string

Filter tickets created before this date (TICKET report)

ticketSearch

string

Search tickets by remarks, chat name, or issue names (TICKET report)

callDirection

string

Filter calls by direction: INBOUND or OUTBOUND (CALL_LOG report)

callStatuses

array of strings

Filter calls by statuses (CALL_LOG report)

callStatuses

callAgentUserIds

array of strings

Filter calls by agent user IDs (CALL_LOG report)

callAgentUserIds

callAccountId

string

Filter calls by calling account ID (CALL_LOG report)

callFromDate

string

Filter calls initiated after this date (CALL_LOG report)

callToDate

string

Filter calls initiated before this date (CALL_LOG report)

callPhoneSearch

string

Search calls by phone number — matches callerNumber, calledNumber, and linked chat wpChatId (CALL_LOG report)

callHasChat

boolean

Filter calls linked to a chat (true) or not linked (false) (CALL_LOG report)

callHasRecording

boolean

Filter calls that have a recording available (true) or not (false) (CALL_LOG report)

callMinDuration

number

Minimum talk duration in seconds (CALL_LOG report)

callMaxDuration

number

Maximum talk duration in seconds (CALL_LOG report)

callHangupCause

string

Search calls by hangup cause (CALL_LOG report)

callContactSearch

string

Search by contact name, phone, or email via linked chat (CALL_LOG report)

goalFromDate

string

Filter goal events recorded after this date (GOAL report)

goalToDate

string

Filter goal events recorded before this date (GOAL report)

goalIds

array of strings

Filter by specific goal IDs (GOAL report)

goalIds

goalChannelIds

array of strings

Filter by specific channel IDs (GOAL report)

goalChannelIds

goalTrackerFilters

string

JSON-encoded array of tracker value filter rules for GOAL reports. Each rule: { field, operator, value }.

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.

202Report generation started