Return a list of channels

Query Params
string

Specifies parameters by which returned results should be ordered. Parameter sort order can be specified by appending :asc for an ascending sort order or :desc for a descending one to the parameter name. Default sort order is ascending and can be omitted. Multiple parameters should be separated by comma.

Result can be ordered by the following parameters: key, title, description, link, author, type and videos_max.

Default is title:asc.

integer

(unsigned integer) Specifies maximum number of channels to return.

Default is 50. Maximum result limit is 1000.

integer

Specifies how many channels should be skipped at the beginning of the result set. Default is 0.

Case-insensitive search in the author, channel_key, description, link, title, and custom fields. Parameter can also include comma-separated list of fields that specifies where search should be done.

Search parameter can be specified in the following ways:

  • search: Only channels that contain search string in at least one of the default search fields will be listed. Default search fields are: author, channel_key, description and title.

  • search:*: Only channels that contain search string in at least one of the default search fields and all custom fields will be listed. Default search fields are: author, channel_key, description and title.

    Only channels that contain search string in at least one of the search fields will be listed. Search fields are: author, channel_key, description, link and title.

  • search:field1[,field2]: Only channels that contain search string in at least one of the fields specified in the list will be listed. Multiple fields in the list must be comma-separated. Allowed fields are: author, channel_key, description, link and title.

  • search:custom.*: Only channels that contain search string in at least one of the custom fields will be listed.

  • search:custom.field1[,custom.field2]: Only channels that contain search string in at least one of the custom fields specified in the list will be listed. Multiple fields in the list must be comma-separated.

  • search:field1[,field2],custom.field1[,custom.field2]: Only channels that contain search string in at least one of the search or custom fields specified in the list will be listed. Multiple fields in the list must be comma-separated.

    An asterisk (*) wildcard field can be used if search should be done in all search fields and/or all custom search fields. For example:

    search:*,custom.field1,custom.field2

    search:field1,field2,custom.*

    search:,custom.

string

Specifies channel type by which returned result should be filtered: manual, dynamic, trending, feed, search, article_matching.

Multiple values can be submitted as a comma separated list.

Headers
string
enum
Defaults to application/xml

Generated from available response content types

Allowed:
Response

Language
URL
LoadingLoading…
Response
Choose an example:
Response
© 2007- Longtail Ad Solutions, Inc.