project.onpage.resources.usage

project.onpage.resources.usage

Provides detailed information on how and where each discovered resource (such as images, JavaScript, or CSS files) is utilized within the given domain. This includes specifics on the pages or elements where these resources are embedded or referenced. You can use the LIMIT parameter to restrict the number of results returned and the PAGE parameter to specify which set of results to retrieve.

Result

The result provides basic information about the project for which data is requested, including the total number of resource usages found and a detailed list of these resources. Each resource entry contains information such as the type of resource (type), the URL (url), the status code (status_code), the size of the resource (size), and the response time (time). Additionally, the source of the resource (source) is included. For image resources, the image alt text (image_alt) and image title (image_title) are also returned.

GET-Parameters

Parameters (Mandatory)

api_key
STRING
Your personal API key. This key is used to authenticate your requests. You can obtain it here.
project
STRING
Specifies the unique hash used to identify a specific project. This hash can be obtained through the project.overview method.

Parameters (Optional)

limit
INTEGER
Specifies the number of reults for each page. Adjust this value to control the number of results returned on each page. By default, this parameter is set to 100.
page
INTEGER
Specifies which set of recources to return. This allows you to choose a specific page of results, with the number of results for each page determined by the limit parameter.
format
STRING
Specifies whether the response will be returned in XML or JSON format. By default, the result will be in XML format.
To be able to use the API documentation with real data, you have to create an API key in your account.
EXAMPLE
$baseUrl = "https://api.sistrix.com/project.onpage.resources.usage";

$post = [



];

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, $baseUrl);

curl_setopt($curl, CURLOPT_POSTFIELDS, $post);

curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);

$response = curl_exec($curl);

curl_close($curl);
import requests

baseUrl = 'https://api.sistrix.com/project.onpage.resources.usage'

post = {



}

response = requests.post(baseUrl, post)

data = response.text
curl https://api.sistrix.com/project.onpage.resources.usage \


let baseUrl = 'https://api.sistrix.com/project.onpage.resources.usage';

let form = new FormData();



fetch(baseUrl, {

    method: 'POST',

    body: form

}).then(function(response){

    return response.text();

}).then(function(data){

    //data contains the results of the request

})