Skip to main content
Skip table of contents

API metering

API metering instructions

DCT employs a per API consumption model, which requires API metering and periodic reporting to Delphix Customer Success. To support reporting of API consumption, DCT offers an API consumption reporting endpoint called, “api-usage-report”. This report will provide a list of all unique API endpoints and how often they were used over the specified time period sorted by API and method.

Required inputs

  • File type: CSV or JSON (CSV file types are compatible with most spreadsheet-style software like Excel or Google Sheets)

  • Start/end date: The default start date is “when DCT was installed” and the default end date is the “time when the report was generated”.

Example cURL call

NONE
curl --location --request GET 'https://[Inser_DCT_Server]/v2/reporting/api-usage-report/?end_date=2022-06-14T09:00-04:00&start_date=2022-06-01T00:00Z' \
--header 'Content-Type: application/json' \
--header 'Accept: text/csv' \
--header 'Authorization: apk  1.xxxxxxxx'

Example output

NONE
api_endpoint,api_method,api_count
"/v2/management/api-clients",GET,2
/v2/management/engines,GET,1
"/v2/management/engines/search",POST,1
"/v2/reporting/api-usage-report",GET,2
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.