Optimizer methods

optimizer.projects

This method returns the hash values and names of the existing optimizer projects. No credits are used in this process.

Required parameter: api_key

https://api.sistrix.com/optimizer.projects?api_key=[API_KEY]

optimizer.project

This method returns information about an optimizer project and the existing tags. Here, the project hash – which can be requested via method optimizer.projects – is transferred to the parameter “project”. With this query, no credits are used.

Required parameter: api_key, project

https://api.sistrix.com/optimizer.project?api_key=[API_KEY]&project=[PROJECT]

optimizer.ranking

This method returns the keywords and existing rankings for an Optimizer project. Here, the project hash is transferred to the parameter “project”. Via the “limit” parameter you can reduce the number of rows returned (where the default value is 100 results); with “tag”, keywords can be filtered according to an existing tag. One returned row costs one credit.

Required parameter: api_key, project
Optional parameter: limit, offset, tag

https://api.sistrix.com/optimizer.ranking?api_key=[API_KEY]&project=[PROJECT]

optimizer.visibility

This method can be used to return the Project Visibility Index for a specific Optimizer project. Please use the project hash with the project parameter. You can also declare an optional date parameter, which will show the results for a previous week. By using the tag parameter you can return the Visibility Index for a specific project-tag. By setting the optional parameter competitors to true, we will also return the results for the competitors that are specified in the specific Optimizer project.

Required parameter: api_key, project
Optional parameter: date, tag, competitors

https://api.sistrix.com/optimizer.visibility?api_key=[API_KEY]&project=[PROJECT]

optimizer.keyword.serps

This method will return the SERPs for a specific keyword within the Optimizer. Please use the project hash with the project parameter. You can also refine your search by using the country, city, device and searchengine parameters to filter your results. This is very useful if you have more than one keyword by the same name. Without the above filter-parameters, the API will return the first keyword found, by default.
You can use the parameter date to query data from previous weeks and num to limit the number of results.

Required parameter: api_key, project, kw
Optional parameter: country, city, device, searchengine, date, num

https://api.sistrix.com/optimizer.keyword.serps?api_key=[API_KEY]&project=[PROJECT]&kw=[KEYWORD]

optimizer.onpage.overview

This method returns all available onpage crawl data. Aside from the time of the crawl, you will receive data on the number of pages crawled and the errors, warnings and hints that were found during the crawl.

Required parameter: api_key, project

https://api.sistrix.com/optimizer.onpage.overview?api_key=[API_KEY]&project=[PROJECT]

optimizer.onpage.crawl

This method returns all the results for a specific onpage crawl. You can use the date parameter to request the data for a previous crawl. You can find all the possible dates through the optimizer.onpage.overview query.

Required parameter: api_key, project
Optional parameter: date

https://api.sistrix.com/optimizer.onpage.crawl?api_key=[API_KEY]&project=[PROJECT]

optimizer.onpage.issue

This method returns detailed results for a specific onpage crawl. You can use the issue parameter to request individual results from the issues you get from the optimizer.onpage.crawl query. By using the date parameter you can request the results for previous crawls.

Required parameter: api_key, project, issue
Optional parameter: date, limit, offset

https://api.sistrix.com/optimizer.onpage.issue?api_key=[API_KEY]&project=[PROJECT]&issue=[ISSUE]

optimizer.start.onpage.check

With this method, you can start an onpage crawl for an Optimizer project via the API. The crawl is then performed as if it had been started manually in the frontend of SISTRIX. The URL requests used are deducted from the contingent of the SISTRIX account.

Required parameter: api_key, project

https://api.sistrix.com/optimizer.start.onpage.check?project=[PROJECT]&api_key=[API_KEY]

optimizer.competitors

This method yields competitors of the domain based on the entered keyword set. In addition to the domain name, the degree of correspondence (0-100) is also provided. The number of domains returned can be reduced with the parameter “num”; without specification, 100 hits are returned.

Required parameter: api_key, project

https://api.sistrix.com/optimizer.competitors?api_key=[API_KEY]&project=[PROJECT]

optimizer.project.urls

This method provides you with all crawled HTML pages of the project. It corresponds to the “URL” table under Onpage > Expert Mode in the frontend of SISTRIX. In addition to the URL, the other table fields (such as file size, title tag and more) are also provided.

Required parameter: api_key, project

https://api.sistrix.com/optimizer.project.urls?api_key=[API_KEY]&project=[PROJECT]

optimizer.project.links

This method provides you with all found links of the project. This includes both internal and external linking. It corresponds to the “Links” table under Onpage > Expert Mode in the frontend of SISTRIX.

Required parameter: api_key, project

https://api.sistrix.com/optimizer.project.links?api_key=[API_KEY]&project=[PROJECT]

optimizer.project.resources

This method provides you with all found resources (images, javascript and CSS files) of the project. It corresponds to the “Resources” table under Onpage > Expert Mode in the frontend of SISTRIX.

Required parameter: api_key, project

https://api.sistrix.com/optimizer.project.resources?api_key=[API_KEY]&project=[PROJECT]

optimizer.project.resources.usage

This method shows you where specifically the found resources are integrated/used. It corresponds to the “Resource Usage” table under Onpage > Expert Mode in the frontend of SISTRIX.

Required parameter: api_key, project

https://api.sistrix.com/optimizer.project.resources.usage?api_key=[API_KEY]&project=[PROJECT]

optimizer.project.cookies

This method shows you which cookies are used in the crawled project. The SISTRIX onpage crawler collects all cookies the web server wants to set, but only saves them and does not use them. It corresponds to the “Cookies” table under Onpage > Expert Mode in the frontend of SISTRIX.

Required parameter: api_key, project

https://api.sistrix.com/optimizer.project.cookies?api_key=[API_KEY]&project=[PROJECT]

optimizer.create.onpage.project

This method can be used to create an on-page project with keywords. The limits within the account are observed.

The parameter crawl_limit can be used to set the maximum number of pages in a project. A maximum of 25,000 pages can be selected via the API.
The parameter project_name can be used to set the project name, alternatively the project scope can be used.
frequency defines the crawl frequency of the project. By default, a weekly crawl is set; the value “manual” is optional. This only affects the on-page project, not the keywords. 
keywords – You can add up to 40 keywords via this parameter. The transfer to the API takes place in JSON format.

Required Parameters: api_key; domain, host, path oder url
Optional Parameters: acknowledge_extra_cost, crawl_limit, project_name, frequency, keywords

https://api.sistrix.com/optimizer.create.onpage.project?api_key=[API_KEY]&domain=sistrix.com