Get the orders report

GET

/cms/analytics/orders

const url = 'https://api.example.com/cms/analytics/orders?order_type=&include_all_orders=0&unit=day';
const options = {method: 'GET', headers: {'API-Key': '<API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.example.com/cms/analytics/orders?order_type=&include_all_orders=0&unit=day' \
  --header 'API-Key: <API-Key>'

Returns order/revenue visits data for a date range.

Authorizations

ApiKeyAuth

Parameters

Query Parameters

date_from

string format: date

Start date (YYYY-MM-DD). Defaults to 7 days ago.

date_to

string format: date

End date (YYYY-MM-DD). Defaults to today.

group

string

Subscription group ID

payment_method

string

Payment method

product

string

Product ID

product_item

string

Product item ID

order_type

string

Allowed values: "" 1 2

‘’=Any, 1=Renewals, 2=New orders

include_all_orders

string

default: 0

Allowed values: 0 1

0=Only subscriptions, 1=Include all orders

unit

string

default: day

Allowed values: day week month

Responses

200

Orders visits data

400

Invalid date range

401

Admin authorization required

403

Insufficient permissions