PRprobely
Target Labels

List Target Labels

Changed on
get/labels/targets/

Request

  • Base URL
    https://api.probely.com
  • URL
    https://api.probely.com/labels/targets/
  • Auth
    API key in header Authorization

Query parameters

assignedboolean
idstring[]

Identifiers of target labels to filter results. Multiple choices are possible by repeating the query_param.

is_id_404_validationboolean

If true, triggers custom response for id filter validation.
If any id filter is invalid, returns a 404 with the following content:

{
    "detail": "Not Found",
    "is_id_404_validation": true,
    "invalid_ids": [
        "9vebyEVLNoZX",
        "6CuzJtJmMp48"
    ]
}
lengthinteger

Number of results to return per page.

orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

searchstring

A search term.

teamstring[]

A unique Base58 value identifying this object.

Response

countinteger

Total number of results.

page_totalinteger

Total number of pages.

pageinteger

Number of the current page.
The first page is 1.
Defaults to 1 if no specific page is requested.

lengthinteger

Number of results returned per page.

Example response

{
  "count": 6,
  "page_total": 1,
  "page": 1,
  "length": 10
}

Changes

  • 8b8322107b18Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the new optional query request parameter id

    • info

      added the new optional query request parameter is_id_404_validation

    • 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

  • c279dcfd5b41Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status