/trail-index/api/v1/index/search

post https://example.com/trail-index/api/v1/index/search

Search for the content based on the search parameters defined

Query Params

offset

integer

Defaults to 0

Offset from which to start fetching objects

limit

integer

Defaults to 50

Maximum number of objects to return

sortdir

string

Defaults to ASC

Sort direction, asc or desc

Body Params

keywords

string

Comma or space-separated strings to search across all connection attributes. The leading and trailing wildcards for the keywords are implicit.

protocol

string

connection_id

string

defines the connection id to be searched for

channel_id

string

defines the channel id to be searched for

start_time

date-time

defines the start time for search - abosulte timestamp in the connection

end_time

date-time

defines the end time for search - absolute timestamp in the connection

start_position

integer

specifies the start position to search for in milliseconds - relative to the start of connection

end_position

integer

specifies the end position to search for in milliseconds - relative to the start of connection

Headers

Authorization

string

required

Defaults to Bearer a-proper-token-goes-here

OAuth2 token

Responses

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://example.com/trail-index/api/v1/index/search?offset=0&limit=50&sortdir=ASC' \
3
     --header 'Authorization: Bearer a-proper-token-goes-here' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful request, respond with a list of connections

400Bad request

401Unauthorized request, OAuth2 authorization missing or invalid

403Unauthorized request, OAuth2 authorization OK but scope insufficient

404Resource not found

500Internal server error