Skip to content

API: Exclude endpoint use and overview

Manage a list of URLs that should be excluded from the results of all other API endpoints. URLs can be both added or removed from the exclusion list. It’s also possible to retrieve a list of currently excluded URLs.

Your API secret is used with this endpoint.

Add a URL to the list of ignored URLs.

Each individual URL will be excluded for a maximum of 90 days, after which it will be automatically evicted from the exclusion list. We currently allow a maximum of 200 URLs per Site ID to be excluded at any given time.

GET /exclude/ignore

Query Parameters

urlCanonical URL for page being trained against profile.

Each individual URL will be excluded for a maximum of 90 days, after which it will be automatically evicted from the exclusion list. We currently allow a maximum of 200 URLs per Site ID to be excluded at any given time.

GET /exclude/include

Remove a URL from the list of ignored URLs (include it in future API URLs).

Query Parameters

urlCanonical URL for page being trained against profile.

GET /exclude/list

Returns the list of currently excluded URLs.

Examples

Add a URL to the list of excluded URLs:

https://api.parsely.com/v2/exclude/ignore?apikey=apikey&secret=secret&url=https://exampleurl.com

Remove a URL from the list of excluded URLs:

https://api.parsely.com/v2/exclude/include?apikey=apikey&secret=secret&url=https://exampleurl.com

Retrieve the list of excluded URLs:

https://api.parsely.com/v2/exclude/list?apikey=apikey&secret=secret

Last updated: August 16, 2023