GET Companies by Search Query

Syntax

The following request is used to retrieve a Companies by searching for them using a specified search query:

Note: The parameters highlighted in red are placeholders for the mandatory values described bellow.

http://api.vidible.tv/COMPANY_KEY/company/search?query=SEARCH_QUERY&PARAMETERS

 

  • COMPANY_KEY - Replace this placeholder with your Company key. 
    Note: If you do not have a Company key, please contact our Support team by clicking here.

  • SEARCH_QUERY - Replace this placeholder with the required search tern or search query using our search syntax.
    Note: For further details, please see How to use our Search Syntax.

  • PARAMETERS - Please refer to the following parameters section to apply any additional query parameters to the request.

 

 

Parameters

The following parameters and values can be added to the request.

Note: As the query string is already opened for the mandatory Company ID and Query parameters u
se the ampersands sign '&' to add multiple parameters and values one after the other within the query string.

 

Parameter Description Value
offset

Enter a numeric value from 0 and up to define how many company results will be skipped from the beginning of the result list.

Note: For example, Specifying two Company IDs in the request and setting the offset filed to 1 will return the second company data only in the response.

offset=number

offset=5

limit

Enter a numeric value from 0 and up to define how many company results will be returned in the response.

Note: For example, Specifying three Company IDs in the request and setting the offset filed to 2 will only return the first two companies in the response.

limit=number

limit=5

hasvideo

Search for companies that either hold/don't hold videos under them.

Note: Setting this field to 'true' will return only companies that have videos under them.

hasvideo=true/false(default)

hasvideo=true

hasvideo=false

sort

Sort the search results according to one of the following options:

  • creationdate - Sort companies according to creation dates.
  • modificationdate - Sort companies according to modification dates.
  • publishdate - Sort companies according to publishing dates.

sort=Sort Option

sort=creationdate

sort=modificationdate

ascending   

Sort your search results according to ascending (first to last) or descending (last to first) order.

ascending=true/false

ascending=true(default: first to last)

ascending=false(last to first)

 

Try it out by clicking here.

 

Examples

Request without Parameters

Method: GET

URL:

http://api.vidible.tv/9d3f3b3ace557e0937be21eef36982ed/company/search?query=name%3A%22support%20testing

Response

[
{
"id": "56d84746e4b0558a22bf8f75",
"name": "Support Testing Studio",
"creationDate": 1457014605697,
"modificationDate": 1463072620602
},
{
"id": "56d5921ce4b0f5991ad44713",
"name": "Support Testing",
"creationDate": 1456837150128,
"modificationDate": 1462289901589
}
]

 

 

Request with Query Parameters

Method: GET

URL:

hhttp://api.vidible.tv/9d3f3b3ace557e0937be21eef36982ed/company/search?query=name%3A%22support%22&offset=0&limit=2&hasvideo=false&sort=creationdate&ascending=false

Response

[
{
"id": "5720be12e4b09b938706cc03",
"name": "Support Testing API Demo",
"creationDate": 1461763605707,
"modificationDate": 1461763605707
},
{
"id": "56d84746e4b0558a22bf8f75",
"name": "Support Testing Studio",
"creationDate": 1457014605697,
"modificationDate": 1463072620602
}
]
Have more questions? Submit a request