GetOrderStats

post

https://{yourlidiaurl}/order/stats/orders

Retrieves aggregated order statistics for the specified date range and filters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The statistics query including date range, status filters, and trend options.

fromDate

string | null

Gets or sets the start date for the statistics period (required).

toDate

string | null

Gets or sets the end date for the statistics period (required).

returnDailyTrend

boolean

Gets or sets whether to include daily trend data in the response.

states

string | null

Gets or sets a comma-separated list of order state values to include in statistics.

property

object

environment

string | null

Gets or sets the environment identifier (e.g., Production, Staging).

applicationIP

string | null

Gets or sets the IP address of the calling application.

userToken

string | null

Gets or sets the user token for authentication context.

sessionId

string | null

Gets or sets the session identifier of the current user session.

userId

string

^-?(?:0|[1-9]\d*)$

Gets or sets the numeric user identifier.

userIP

string | null

Gets or sets the IP address of the requesting user.

envelope

string | null

Gets or sets the envelope parameter for response shaping.

threadId

string | null

Gets or sets the thread identifier for request tracing and correlation.

includes

array of strings | null

Gets or sets the list of related entities to include in the response (e.g., Lines, Properties, Tags).

includes

searchKey

string | null

Gets or sets the search keyword used for full-text or partial matching.

pageIndex

string

^-?(?:0|[1-9]\d*)$

Gets or sets the page index for pagination (1-based).

pageSize

string

^-?(?:0|[1-9]\d*)$

Gets or sets the number of records per page for pagination.

sorting

string | null

Gets or sets the sorting expression (e.g., "Created desc", "Name asc").

status

array of objects | null

Gets or sets the list of entity statuses to filter by.

status

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

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

text/plain

application/json

text/json

200Aggregated order statistics including totals, counts, and optionally daily trends.