API Reference

Get usage events report for a period of time

get
https://appapi.heymantle.com/v1/usage_events/report

Returns usage event histogram data with optional filtering by event properties

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

The customer ID. Can be the Mantle customer ID, app installation ID, Shopify shop ID, or myshopify domain.

string
required

The name of the event to query

string

JSON-encoded array of filter objects with property, operator, and value

string
enum
Defaults to daily
Allowed:
date
date
string
enum
Defaults to count
Allowed:
string

Property name for sum or unique calculations

Headers
string
required

The App Id when you create an API key in your Mantle dashboard.

string
required

The API key for your app from your Mantle dashboard.

Responses

400

Bad request - missing required parameters or invalid input

500

Internal Server Error

Updated 4 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?