PRprobely
Navigation and Login Sequences

List Sequences

Changed on
get/targets/{target_id}/sequences/

Request

  • Base URL
    https://api.probely.com
  • URL
    https://api.probely.com/targets/{target_id}/sequences/
  • Auth
    API key in header Authorization

Path parameters

target_idstring required

Identifier of the target.

Query parameters

enabledboolean
include'content' | 'target'

Extra fields to include in response:

  • content - Add content to response under content key
  • target - Add target to response under target key
lengthinteger

Number of results to return per page.

namestring
orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

searchstring

A search term.

type'login' | 'navigation'
  • login - Login
  • navigation - Navigation

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

  • 0b2f6cbe644dRevision changes
    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • 9eb266f39837Revision changes
    • breaking

      the response property //// became optional for the status

    • info

      the response's property default value false was added for the status