Skip to main content
GET
/
entities
/
{entityId}
/
insights
/
sales-revenue
Get sales revenue
curl --request GET \
  --url https://api.syntage.com/entities/{entityId}/insights/sales-revenue \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "mxnAmount": 39934.827,
      "metric": 39934.827,
      "date": "202408",
      "dateLabel": "2024/Aug",
      "startDate": "2024-08-01",
      "transactions": 6,
      "dimension": "total",
      "label": "total",
      "groupName": "total"
    }
  ],
  "stats": [
    {
      "total": 50,
      "hits": 48,
      "date": "202408",
      "dateLabel": "2024/Aug",
      "startDate": "2024-08-01"
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

​
entityId
string<uuid>
required

Query Parameters

​
options[from]
string<date-time>

Filter by invoice issuing date (greater than)

​
options[to]
string<date-time>

Filter by invoice issuing date (less than)

​
options[periodicity]
enum<string>
default:monthly

The data set is grouped by this field

Available options:
daily,
weekly,
monthly,
quarterly,
yearly
​
options[type]
enum<string>
default:total

The type of expenditure

Available options:
total,
currency,
customers,
export,
customer-type,
payment-type,
products

Response

Sales Revenue

​
data
object[]

Sales revenue data grouped by period and dimension

​
stats
object[]

Data quality statistics per period, indicating how many invoices had the required fields for accurate calculation.