Slas

List Metric Definitions (POST)

Lists metric definitions matching a filter.

POST
/metric-definitions.list
AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

type?array<metric-definition-metric-type>

The type of metric definitions sought.

applies_to_type?array<metric-definition-applies-to>

The type of objects the metric definition applies to.

cursor?string

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

Formattext
include_custom_metrics?boolean

Whether to include custom metrics in the response. If not set, then custom metrics are excluded.

limit?integer

The maximum number of records to return. The default is '50'.

Formatint32
mode?list-mode

The iteration mode to use. If "after", then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If "before", then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

Value in"after" | "before"
sort_by?array<string>

Fields to sort the records by and the direction to sort them.

status?array<metric-definition-status>

The status of the metric definition.

Response Body

curl -X POST "https://api.devrev.ai/metric-definitions.list" \  -H "Content-Type: application/json" \  -d '{}'
{
  "metric_definitions": [
    {
      "created_by": {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      },
      "created_date": "2023-01-01T12:00:00.000Z",
      "display_id": "string",
      "id": "string",
      "modified_by": {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      },
      "modified_date": "2023-01-01T12:00:00.000Z",
      "name": "string"
    }
  ],
  "next_cursor": "string",
  "prev_cursor": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}
{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}
{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}
{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}