Revenue

Reference document for the endpoint that produces revenue data

The Revenue endpoint retrieves the revenue and revenue growth for a specific company connection, over one or more periods of time.

Refer to the Lending reporting structure page for more detail on reports in Lending.

For Revenue, these are the dimensions and measures:

Dimensions

• Period
• Revenue

Measures

• Value
• Percentage change - The percentage change between present period’s value and previous period's value.

Report Data

• Is structured based on dimension (index =“0”), i.e. Period.
• The endpoint will return the revenue and revenue growth as a percentage change for each period.

View the Revenue formulas.

The endpoint is available in our API reference.

GET /data/companies/{companyId}/connections/{connectionId}/lending/commerceMetrics/revenue

Parameters

Parameter	Type	Description	Required
reportDate	string, See Date	YYYY-MM-DD, Datetime or Date (inclusive of the whole day).	Required
periodUnit	string	The period unit of time returned, and it can be: “Day”, “Week”, “Month”, “Year”.	Required
periodLength	integer	Based on the period unit provided. It must be positive, not zero and an integer.	Required
numberOfPeriods	integer	The number of periods to return. It must be positive, not zero and an integer.	Required
includeDisplayNames	boolean	Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. Default is false.	Optional

Data model

The response structure is split into four areas: Report info, Dimensions, Measures and Report data.

Report info

Field	Type	Description
name	string	"revenue"
displayName	string	"Revenue"

Dimensions

Revenue consists of these dimensions: Period and Revenue.

Dimension (index = “0”): Period

Field	Type	Description
displayName	string	"Period"
type	string	"datespan"
items	array, See Dimension (index = "0") items	Returns an array of "Period". This is driven by the query parameter values. Ordered by latest to earliest periods.

Dimension (index = “0”) items

Field	Type	Description
displayName	string	"Period n"
start	string, See Date	YYYY-MM-DD Date in which the period begins (inclusive).
end	string, See Date	YYYY-MM-DD Date in which the period ends (inclusive).

Dimension (index = “1”): Revenue

Field	Type	Description
displayName	string	"Revenue"
type	string	"string"
items	array, See Dimension (index = "1") items	Returns an array of revenue metrics.

Dimension (index = “1”) items

Field	Type	Description
value	string	Revenue value or Revenue growth. These will always show for any response in this report. The dimension values are not dependent on the user's query parameters.

Measures

Measures provide information about the measures contained in the report data.

The two measures for this report are as follows:

Index “0” - value

Field	Type	Description
displayName	string	"Value"
units	string	The base currency of the company's commerce connection.
type	string	"currency"

Index “1” - percentage change

Field	Type	Description
displayName	string	"Percentage change vs. previous period"
units	string	"%"
type	string	"percentage"

Report data

The report data combines multiple reporting dimensions and outputs the value of each combination. Each dimension reference is specified.

Since the report data is reflective of two dimensions and their measures, the tables below represent each component grouping.

Each object is grouped by dimension (index=“0”) which is the number of periods specified by the user in the query parameters.

Each period will be broken down into Revenue and both value and percent change measures are included for each level.

Components structure

Field	Type	Description
dimension	number	Index 1
dimensionDisplayName	string	Shows when includeDisplayNames is set to true.
item	number
itemDisplayName	string	Shows when includeDisplayNames is set to true.
measures	See Measures in components

All components have the structure described in the Measures in components data model below.

Measures in components

Index "0" (Revenue)

Field	Type	Description
measureDisplayName	string	"Value"
value	number

Index “1” (Revenue growth)

Field	Type	Description
measureDisplayName	string	"Percentage change vs previous period". If the system can't calculate the percentage change, this object will not display.
value	string	"%"

Example data

{
  "reportInfo": {
      "name": "revenue",
      "displayName": "Revenue"
  },
  "dimensions": [
      {
          "index": 0,
          "displayName": "Period",
          "type": "datespan",
          "items": [
              {
                  "index": 0,
                  "displayName": "Period 0",
                  "start": "2021-04-15",
                  "end": "2021-05-15"
              },
              {
                  "index": 1,
                  "displayName": "Period 1",
                  "start": "2021-05-15",
                  "end": "2021-06-15"
              }
          ]
      },
      {
          "index": 1,
          "displayName": "Revenue metrics",
          "type": "string",
          "items": [
              {
                  "index": 0,
                  "value": "Revenue"
              },
              {
                  "index": 1,
                  "value": "Revenue growth"
              }
          ]
      }
  ],
  "measures": [
      {
          "displayName": "Value",
          "units": "GBP",
          "index": 0,
          "type": "currency"
      },
      {
          "displayName": "Percentage change vs. previous period",
          "units": "%",
          "index": 1,
          "type": "percentage"
      }
  ],
  "reportData": [
      {
          "dimension": 0,
          "dimensionDisplayName": "Period",
          "item": 0,
          "itemDisplayName": "Period 0",
          "components": [
              {
                  "dimension": 1,
                  "dimensionDisplayName": "Revenue metrics",
                  "item": 0,
                  "itemDisplayName": "Revenue",
                  "measures": [
                      {
                          "index": 0,
                          "measureDisplayName": "Value",
                          "value": 141.81
                      }
                  ]
              },
              {
                  "dimension": 1,
                  "dimensionDisplayName": "Revenue metrics",
                  "item": 1,
                  "itemDisplayName": "Revenue growth",
                  "measures": [
                      {
                          "index": 1,
                          "measureDisplayName": "Percentage change vs. previous period",
                          "value": -54.23
                      }
                  ]
              }
          ]
      },
      {
          "dimension": 0,
          "dimensionDisplayName": "Period",
          "item": 1,
          "itemDisplayName": "Period 1",
          "components": [
              {
                  "dimension": 1,
                  "dimensionDisplayName": "Revenue metrics",
                  "item": 0,
                  "itemDisplayName": "Revenue",
                  "measures": [
                      {
                          "index": 0,
                          "measureDisplayName": "Value",
                          "value": 375.64
                      }
                  ]
              },
              {
                  "dimension": 1,
                  "dimensionDisplayName": "Revenue metrics",
                  "item": 1,
                  "itemDisplayName": "Revenue growth",
                  "measures": [
                      {
                          "index": 1,
                          "measureDisplayName": "Percentage change vs. previous period",
                          "value": 164.89
                      }
                  ]
              }
          ]
      }
  ]
}