GET
/
insights
/
{id}
/
sales-revenue
Get sales revenue
curl --request GET \
  --url https://api.syntage.com/insights/{id}/sales-revenue \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "mxnAmount": 39934.827,
      "groupName": "total",
      "date": "2014-01",
      "dateLabel": "2014/Jan",
      "transactions": 0
    }
  ],
  "stats": [
    {
      "total": 2,
      "hits": 2,
      "date": "2014-01",
      "dateLabel": "2014/Jan"
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string
required

RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13
Example:

"PEIC211118IS0"

Query Parameters

​
options[from]
string

Filter by invoice issuing date (greater than)

​
options[to]
string

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

200
application/ld+json

Sales Revenue

The response is of type object.