Site Filtering

This API call returns a stream of line-delimited JSON where each line of output is a single JSON object representing one site. The site object contains the site ID, its title, IsDeleted, the Pub Account ID, and the URL. By default, the endpoint returns all non-deleted sites saved in an account.

📘

Note

Filtering is a simple match of the string. Wildcards, regular expressions etc. are not available. Both query parameters may be used together (e.g. ?titleLike=adzerk&urlLike=.com`)

🚧

Caution

Some special characters need to be urlencoded to be used in the query parameter. For example:

# - %23
% - %25
& - %26

Query Params
string

Filters the stream of sites based on the Title. This is a simple match - if the string provided in the query parameter is present anywhere in a site's Title, that site will be returned in the results. Example: ?titleLike=adzerk

string

Filters the stream of sites based on the Url. This is a simple match - if the string provided in the query parameter is present anywhere in a site's Url, that site will be returned in the results. Example: ?urlLike=adzerk.com

Response

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json