COcodatio
Reports

Get customer retention metrics

Changed on

Gets the customer retention metrics for a specific company connection, over one or more periods of time.

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

Request

  • Base URL
    https://api.codat.io
  • URL
    https://api.codat.io/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/customerRetention
  • Auth
    API key in header Authorization

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

  • 0167fa08722eRevision 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

  • 7ca7ffc3edf1Revision 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