Usage

Get usage by fully qualified name

Get usage details for an entity identified by fully qualified name.

get/v1/usage/{entity}/name/{fqn}

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/usage/{entity}/name/{fqn}
  • Auth: HTTP bearer

Path parameters

entitystring required
Example:table, report, metrics, or dashboard

Entity type for which usage is requested

fqnstring required

Fully qualified name of the entity that uniquely identifies an entity

Query parameters

daysinteger

Usage for number of days going back from the given date (default=1, min=1, max=30)

datestring

Usage for number of days going back from this date in ISO 8601 format (default = currentDate)

Response

Entity usage

Changes

No recorded changes to this operation across all 1 revision of this API.