We’ve migrated our documentation to a new site, which means some URLs have changed.
Audience

/profile/content/push

Pushes a given URL for content profile generation. The URL will be queued for crawling. Normally pages will be crawled as a result of user engagement with the page, but this API can be used to given the crawler a hint to retrieve a page without waiting for traffic events. Note that this API does not provide guarantees about when or even if the page will be crawled as a result of invoking this API.

The user must be authenticated and have write permissions to the associated site.

Request

The request object has the following fields:

Name

Type

Required

Description

url

String

Yes

The URL to be re-crawled and re-processed.

Note that the argument is a URL. The authorization check currently looks at the site identifier found when the domain's top level page (i.e., the URL without its path or any parameters) was last crawled to establish if the user has the required permissions. Hence, to be able to push the URL http://www.example.com/foo/bar, the cXense script has to be present on http://www.example.com.

Response

The response object has the following fields:

Name

Type

Description

url

String

The URL of the enqueued page, corresponding to the url of the request.

Examples

Bash
$ python cx.py /profile/content/push '{"url":"https://www.example.com"}'
{
 "url": "https://www.example.com"
}

Last updated: