COcodatio
Sales

Get commerce revenue metrics

Changed on

The Get revenue report endpoint returns the revenue and revenue growth for a specific company connection over one or more periods of time.

This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company.

Learn more about the formulas used to calculate the revenue metrics.

Response structure

The Revenue report's dimensions and measures are:

IndexDimensions
index = 0Period
index = 1Revenue
IndexMeasures
index = 0Value
index = 1Percentage change, defined as the change between the current and previous periods' values and expressed as a percentage.

The report data then combines multiple reporting dimensions and measures and outputs the value of each combination.

get/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/revenue

Request

Query parameters

reportDatestring required
Example:29-09-2020

The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.

periodLengthinteger required

The number of months per period. E.g. 2 = 2 months per period.

numberOfPeriodsinteger required

The number of periods to return. There will be no pagination as a query parameter.

periodUnit'Day' | 'Week' | 'Month' | 'Year' required

The period unit of time returned.

includeDisplayNamesboolean

Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.

Response

OK

reportInfoobject
dimensionsCommerceReportDimension[] (unresolved $ref)
measuresCommerceReportMeasure[] (unresolved $ref)
reportDataCommerceReportComponent[] (unresolved $ref)
errorsCommerceReportError[] (unresolved $ref)

Changes

  • 2244d9343d0aRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 799afe3f1a9fRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status