Topvisor API

https://topvisor.com/ru/api/v2
Admin
Topvisor API v2 is a comprehensive REST API that enables developers to programmatically manage SEO...
Tokens:57,784
Snippets:396
Trust Score:10
Update:1 hour ago
Show doc for...
Tokens:
Raw
### SDK Example (PHP)

Source: https://topvisor.com/ru/api/v2/basic-params/paging/

Example of using the Topvisor SDK in PHP to paginate through results using the limit and offset parameters.

```php
<?php

$projectId = '%NN%'; // ID of your project
$limit = 10; // page size

$TVSession = new TV\Session();

$selectorKeywords = new TV\Pen($TVSession, 'get', 'keywords_2', 'keywords');
$selectorKeywords->setData(['project_id' => $projectId]);
$selectorKeywords->setLimit($limit);

// get all result pages
do{
    $page = $selectorKeywords->exec();
    if(is_null($page->getResult())) return var_dump($page->getErrors());

    // $page - array of keywords
    foreach($page->getResult() as $resultItem){
        var_dump($resultItem);
    }

    $nextOffset = $page->getNextOffset();
    if($nextOffset) $selectorKeywords->setOffset($nextOffset);
}while($nextOffset);
```

--------------------------------

### Example: First 10 Results

Source: https://topvisor.com/ru/api/v2/basic-params/paging/

Example request and response for retrieving the first page of results with a limit of 10 and offset of 0.

```APIDOC
## Example: First 10 Results

### Request
```json
{"limit":10, "offset":0}
```

### Response
```json
{"result":[ /* first 10 results */ ],"nextOffset":10,"total":25}
```
```

--------------------------------

### Example: Results 10-20

Source: https://topvisor.com/ru/api/v2/basic-params/paging/

Example request and response for retrieving the second page of results (items 11-20) using offset 10.

```APIDOC
## Example: Results 10-20

### Request
```json
{"limit":10, "offset":10}
```

### Response
```json
{"result":[ /* Results 11 to 20 */ ],"nextOffset":20,"total":25}
```
```

--------------------------------

### Example: Results 20-25

Source: https://topvisor.com/ru/api/v2/basic-params/paging/

Example request and response for retrieving the last page of results (items 21-25) using offset 20. Note that nextOffset is not returned because this is the last page.

```APIDOC
## Example: Results 20-25

### Request
```json
{"limit":10, "offset":20}
```

### Response
```json
{
  "result":[ /* Results 21 to 25 */ ],
  "total":25
  // note: since this is the last page, nextOffset is not returned
}
```
```

--------------------------------

### POST /v2/json/get/{service}/{method}

Source: https://topvisor.com/ru/api/v2/operators/get/

The get operator retrieves objects and other data types from the Topvisor API. Use request parameters to specify fields, filtering, sorting, or pagination. The result is an array of objects or values, or null on error.

```APIDOC
## [POST] /v2/json/get/{service}/{method}

### Description
The get operator retrieves objects and other data types from the Topvisor API. Use request parameters to specify fields, filtering, sorting, or pagination. The result is an array of objects or values, or null on error.

### Method
POST

### Endpoint
/v2/json/get/{service}/{method}

### Parameters
#### Path Parameters
- **service** (string) - Required - The service name.
- **method** (string) - Required - The method name.

### Response
#### Success Response (200)
- **result** (array) - Array of objects or values depending on the method.

#### Error Response
- **result** (null) - Returned in case of request execution error.

```

--------------------------------

### PHP example using TV\Fields with filters and sorting

Source: https://topvisor.com/ru/api/v2/sdk-php/fields/

Shows how to use TV\Fields::genFilterData and genOrderData to add filters and sorting to a selector. Filters include CONTAIN, IN, and NOT_EQUALS operators; sorting uses ASC direction.

```php
	<?php
	//...
	$selectorKeywords = new TV\Pen($Session, 'get', 'keywords_2', 'keywords');

	// добавить 3 фильтра
	$selectorKeywords->setFilters([
		TV\Fields::genFilterData('name', 'CONTAIN', ['а']), // в ключевой фразе есть буква "а"
		TV\Fields::genFilterData('tags', 'IN', [1, 2]), // ключевая фраза имеет тег 1 или 2
		TV\Fields::genFilterData('target', 'NOT_EQUALS', ['']) // у ключевой фразы целевая ссылка не пуста
	]);

	// отсортировать ключевые фразы по алфавиту
	$selectorKeywords->serOrders([
		TV\Fields::genOrderData('name', 'ASC')
	]);
	//...

```

--------------------------------

### Пример SDK: получение списка запросов

Source: https://topvisor.com/ru/api/v2/basic-params/paging/

Пример использования SDK для постраничного получения списка запросов из проекта. Использует TV\Session, TV\Pen с оператором 'get' и методами setLimit, setOffset, exec, getResult, getNextOffset.

```php
	<?php

	$projectId = '%NN%'; // ID of your project
	$limit = 10; // page size

	$TVSession = new TV\Session();

	$selectorKeywords = new TV\Pen($TVSession, 'get', 'keywords_2', 'keywords');
	$selectorKeywords->setData(['project_id' => $projectId]);
	$selectorKeywords->setLimit($limit);

	// get all result pages
	do{
		$page = $selectorKeywords->exec();
		if(is_null($page->getResult())) return var_dump($page->getErrors());

		// $page - array of keywords
		foreach($page->getResult() as $resultItem){
			var_dump($resultItem);
		}

		$nextOffset = $page->getNextOffset();
		if($nextOffset) $selectorKeywords->setOffset($nextOffset);
	}while($nextOffset);
```

--------------------------------

### GET /webScreens_2

Source: https://topvisor.com/ru/api/v2-services/webscreens_2/get/

Returns binary image data in PNG format for a web page screenshot. On error, returns a standard API structure in JSON. Creating one screenshot costs 0.1 rubles.

```APIDOC
## [GET] /webScreens_2

### Description
Returns binary image data in PNG format for a web page screenshot. On error, returns a standard API structure in JSON. Creating one screenshot costs 0.1 rubles.

### Method
GET

### Endpoint
/webScreens_2

### Parameters
#### Required Parameters
- **url** (string) - Required - URL of the web page
- **w** (int) - Required - Screen width
- **h** (int) - Required - Screen height

#### Optional Parameters
- **timeout_ms** (int) - Optional - Maximum time to wait for page load before taking screenshot (from 1 to 30000 milliseconds). Default: 1500
- **lang** (string) - Optional - Browser language (e.g., ru, en). Default: language of the user making the API request
- **full_page** (bool) - Optional - Take a full-size screenshot of the page (cannot be used simultaneously with clip parameters). Default: false
- **clip_w** (int) - Optional - Width of the clip region
- **clip_h** (int) - Optional - Height of the clip region
- **clip_x** (int) - Optional - X coordinate of the top-left corner of the clip region
- **clip_y** (int) - Optional - Y coordinate of the top-left corner of the clip region

### Response
#### Success Response
Returns binary image data in PNG format.

#### Error Response
Returns standard API structure in JSON.

```

--------------------------------

### Create Pen object and execute request

Source: https://topvisor.com/ru/api/v2/sdk-php/pen/

Use the Pen object to build and execute an API request. Set parameters with setData and limit with setLimit, then call exec() to get a page object.

```php
<?php
	//...
	$projectId = '%NN%';

	$selectorKeywords = new TV\Pen($Session, 'get', 'keywords_2', 'keywords');
	$selectorKeywords->setData(['project_id' => $projectId]);
	$selectorKeywords->setLimit(10);

	$page = $selectorKeywords->exec();
	//...
```

--------------------------------

### HTTP-запрос оператора get: POST /v2/json/get/{service}/{method}

Source: https://topvisor.com/ru/api/v2/operators/get/

Используется для получения объектов и других типов данных в API v2. В качестве result возвращается массив объектов или значений в зависимости от метода; при ошибке выполнения запроса result равен null.

```http
POST /v2/json/get/{service}/{method}
```

--------------------------------

### POST /v2/json/get/keywords_2/keywords/ (without fields)

Source: https://topvisor.com/ru/api/v2/basic-params/fields/

Retrieves a list of keywords for a project, returning only the default fields (e.g., ID). This example shows the default behavior when the 'fields' parameter is not specified.

```APIDOC
## [POST] /v2/json/get/keywords_2/keywords/

### Description
Retrieves a list of keywords for a project, returning only the default fields (e.g., ID). This example shows the default behavior when the 'fields' parameter is not specified.

### Method
POST

### Endpoint
/v2/json/get/keywords_2/keywords/

### Parameters
#### Request Body
- **project_id** (number) - Required - The ID of the project.

### Request Example
{
  "project_id": 123
}

### Response
#### Success Response (200)
- **result** (array) - List of keyword objects with default fields (e.g., id).

#### Response Example
{
  "result": [
    {"id": "80764821"},
    {"id": "80764822"}
  ]
}
```

--------------------------------

### get: history/summary

Source: https://topvisor.com/ru/api/v2-services/bank_2/log/

Получить суммы пополнений и списаний денежных средств с баланса, сгруппированные по назначениям. Возвращает агрегированные данные по операциям.

```APIDOC
## get: history/summary

### Description
Получить суммы пополнений и списаний денежных средств с баланса, сгруппированные по назначениям.

### Method
get

### Endpoint
history/summary

### Response
#### Success Response
Возвращает суммы пополнений и списаний, сгруппированные по назначениям операций (target).
```

--------------------------------

### get /webscreens_2

Source: https://topvisor.com/ru/api/v2-services/webscreens_2/

Создает скриншот веб-страницы в формате .png. Требуется указать URL страницы, ширину и высоту экрана; поддерживаются полноэкранные снимки, настройка размеров фрагмента и языка браузера.

```APIDOC
## GET /webscreens_2

### Description
Создает скриншот веб-страницы в формате .png. Требуется указать URL страницы, ширину и высоту экрана; поддерживаются полноэкранные снимки, настройка размеров фрагмента и языка браузера.

### Method
GET

### Endpoint
/webscreens_2

### Parameters
#### Query Parameters
- **url** (string) - Required - URL страницы для скриншота
- **width** (integer) - Required - Ширина экрана
- **height** (integer) - Required - Высота экрана
- **fullscreen** (boolean) - Optional - Создание полноэкранного скриншота
- **fragment_width** (integer) - Optional - Ширина фрагмента
- **fragment_height** (integer) - Optional - Высота фрагмента
- **browser_language** (string) - Optional - Язык браузера

### Response
#### Success Response (200)
- **image** (file) - Скриншот в формате .png

#### Response Example
[PNG image]
```

--------------------------------

### Pagination Parameters (limit and offset)

Source: https://topvisor.com/ru/api/v2/basic-params/paging/

Describes the pagination parameters used in read operations (get operator) to control page size and offset. Results are limited to 10,000 per page, and the response includes nextOffset and total when more results are available.

```APIDOC
## Pagination Parameters (limit and offset)

### Description
These parameters are used for read operations (get operator) to paginate through results. The limit parameter defines the page size (default 10,000, max 10,000), and offset specifies the number of items to skip. When not all results are returned, the response includes nextOffset and total fields.

### Parameters
#### Query Parameters (in request body)
- **limit** (integer) - Optional - Maximum number of results per page (default 10,000, max 10,000)
- **offset** (integer) - Optional - Number of items to skip before starting to collect the result set

### Request Example
```json
{"limit":10, "offset":0}
```

### Response
#### Success Response (200)
- **result** (array) - The page of results
- **nextOffset** (integer) - Offset for the next page (only present if more results are available)
- **total** (integer) - Total number of results

#### Response Example
```json
{"result":[ /* first 10 results */ ],"nextOffset":10,"total":25}
```

### Notes
- The maximum page size is 10,000 results.
- The nextOffset field is omitted when the current page is the last one.
```

--------------------------------

### get: sitemap/checker/price

Source: https://topvisor.com/ru/api/v2-services/audit_2/sitemap/

Retrieves the cost of generating a sitemap for the project. Use this endpoint to check the price before starting the generation process.

```APIDOC
## [GET] sitemap/checker/price

### Description
Retrieves the cost of generating a sitemap for the project.

### Method
GET

### Endpoint
sitemap/checker/price

### Parameters
No parameters documented.

### Response
#### Success Response
No response schema documented.

#### Response Example
No response example documented.
```

--------------------------------

### GET /system_2/common/regions

Source: https://topvisor.com/ru/api/v2-services/system_2/common/get-regions/

Searches the regions database. Use the GET method with the specified parameters.

```APIDOC
## [GET] /system_2/common/regions

### Description
Allows searching the regions database.

### Method
GET

### Endpoint
/system_2/common/regions

### Parameters
#### Query Parameters
- **searcher_key** (int) - Required - Search engine key
- **search** (string) - Required - Search phrase
- **country_code** (string) - Optional - Country code per ISO 3166-1 alpha-2
- **only_countries** (boolean) - Optional - Search only countries
```

--------------------------------

### Подключение SDK Topvisor к скриптам

Source: https://topvisor.com/ru/api/v2/sdk-php/

Подключение файлов SDK Topvisor для PHP. Используйте namespace Topvisor\TopvisorSDK\V2. Вместо '...' укажите путь до файла autoload, если используете composer, или раскомментируйте строки include_once для подключения SDK без composer.

```php
<?php

use Topvisor\TopvisorSDK\V2 as TV;

// вместо "..." необходимо прописать путь до файла autoload, если вы используете composer 
include(__DIR__.'/../../vendor/autoload.php');

// пропишите путь к SDK Topvisor, если вы не используете composer
//include_once('topvisor‑sdk/src/V2/Fields.php');
//include_once('topvisor‑sdk/src/V2/Page.php');
//include_once('topvisor‑sdk/src/V2/Pen.php');
//include_once('topvisor‑sdk/src/V2/Session.php');
```

--------------------------------

### Получение ключевых фраз через SDK Topvisor PHP (метод get/keywords_2/keywords)

Source: https://topvisor.com/ru/api/v2/sdk-php/example/

Пример получения ключевых фраз с помощью метода get/keywords_2/keywords/ через SDK Topvisor для PHP. Использует классы Topvisor\TopvisorSDK\V2 (Session, Pen, Fields). Требуется указать ID проекта в переменной $projectId и путь до autoload.php при использовании composer. Запрос получает поля id и name, фильтрует по тегам 1, 2 или 3, сортирует по имени (ASC) и получает по 1000 фраз за обращение. Цикл do-while продолжает получать страницы, пока есть следующий offset. При ошибке выводит ошибки через var_dump.

```php
	<?php

	use Topvisor\TopvisorSDK\V2 as TV;

	// вместо "..." необходимо прописать путь до файла autoload, если вы используете composer 
	include(__DIR__.'/../../vendor/autoload.php');

	// пропишите путь к SDK Topvisor, если вы не используете composer
	//include_once('topvisor-sdk/src/V2/Fields.php');
	//include_once('topvisor-sdk/src/V2/Page.php');
	//include_once('topvisor-sdk/src/V2/Pen.php');
	//include_once('topvisor-sdk/src/V2/Session.php');

	$projectId = '%NN%'; // ID вашего проекта

	// создание сессии
	$Session = new TV\Session();

	// начало построения запроса
	$selectorKeywords = new TV\Pen($Session, 'get', 'keywords_2', 'keywords');

	// установка параметра project_id
	$selectorKeywords->setData(['project_id' => $projectId]);

	// запрос на получение id и имени ключевой фразы
	$selectorKeywords->setFields(['id', 'name']);

	// фильтр ключевых фраз с тегом 1, 2 или 3
	$selectorKeywords->setFilters([
		TV\Fields::genFilterData('tags', 'IN', [1,2,3])
	]);

	// сортировка ключевых фраз по алфавиту
	$selectorKeywords->serOrders([
		TV\Fields::genOrderData('name', 'ASC')
	]);

	// получать по 1000 ключевых фраз за одно обращение к API
	$selectorKeywords->setLimit(1000);

	do{
		// выполнение запроса (получить страницу с результатами)
		$page = $selectorKeywords->exec();

		// обработка ошибки
		if(is_null($page->getResult())) return var_dump($page->getErrors());

		// $page - array of keywords
		foreach($page->getResult() as $resultItem){
			echo $resultItem->id.': '.$resultItem->name.'<br>';
		}

		// есть ли еще неполученные ключевые фразы
		// (если эта страница последняя, $nextOffset будет равен null)
		$nextOffset = $page->getNextOffset();
		if($nextOffset) $selectorKeywords->setOffset($nextOffset);

	// продолжать получать ключевые фразы, пока все страницы не будут получены
	}while($nextOffset);
```

--------------------------------

### GET /bank_2/history

Source: https://topvisor.com/ru/api/v2-services/bank_2/log/get-history/

Retrieves the history of deposits and withdrawals of funds from the balance. This method returns the operation log entries for the bank service.

```APIDOC
## [GET] /bank_2/history

### Description
Retrieves the history of deposits and withdrawals of funds from the balance.

### Method
GET

### Endpoint
/bank_2/history

### Parameters
#### Required Parameters
- **fields** (array fields) - Required - Returned fields of the "Operation Log" object.

### Response
#### Success Response (200)
Returns the operation log entries as specified by the `fields` parameter.

#### Response Example
(No response example provided in the source.)
```

--------------------------------

### GET apometr/calendar

Source: https://topvisor.com/ru/api/v2-services/content_2/apometr/

Получает календарь апдейтов.

```APIDOC
## [GET] apometr/calendar

### Description
Получает календарь апдейтов.

### Method
GET

### Endpoint
apometr/calendar
```

--------------------------------

### GET apometr/textCalendar

Source: https://topvisor.com/ru/api/v2-services/content_2/apometr/

Получает календарь текстовых апдейтов.

```APIDOC
## [GET] apometr/textCalendar

### Description
Получает календарь текстовых апдейтов.

### Method
GET

### Endpoint
apometr/textCalendar
```

--------------------------------

### SDK PHP для bank_2/history

Source: https://topvisor.com/ru/api/v2/first-call/

Пример использования SDK Topvisor PHP для выполнения того же запроса. Требуется установка SDK и указание пути к autoload. Использует классы Session, Pen, Fields. Выводит ошибки или результат.

```php
<?php

use Topvisor\TopvisorSDK\V2 as TV;

// вместо "..." необходимо прописать путь до файла autoload, если вы используете composer
include(__DIR__.'/../../autoload.php');

// пропишите путь к SDK Topvisor, если вы не используете composer
//include_once('topvisor‑sdk/src/V2/Fields.php');
//include_once('topvisor‑sdk/src/V2/Page.php');
//include_once('topvisor‑sdk/src/V2/Pen.php');
//include_once('topvisor‑sdk/src/V2/Session.php');

// $accessToken равен API key
$TVSession = new TV\Session(['userId' => $userId, 'accessToken' => $accessToken]);

$selectorBankHistory = new TV\Pen($TVSession, 'get', 'bank_2', 'history');
$selectorBankHistory‑>setFields(['date', 'info', 'sum']);
$selectorBankHistory‑>setOrders([
	TV\Fields::genOrderData('date', 'DESC')
]);
$selectorBankHistory‑>setLimit(10);

$page = $selectorBankHistory‑>exec();

// catch error
if(is_null($page‑>getResult())){
	var_dump($page‑>getErrors());
	return;
}

// is array of bank history
var_dump($page‑>getResult());
```

--------------------------------

### GET apometr/updates

Source: https://topvisor.com/ru/api/v2-services/content_2/apometr/

Получает даты апдейтов из Апометра.

```APIDOC
## [GET] apometr/updates

### Description
Получает даты апдейтов из Апометра.

### Method
GET

### Endpoint
apometr/updates
```

--------------------------------

### Create default session using config.php

Source: https://topvisor.com/ru/api/v2/sdk-php/session/

Initializes a TV\Session object with default authentication parameters from config.php when $auth is not specified.

```php
<?php
//...
$Session = new TV\Session();
//...
```

--------------------------------

### GET apometr/history

Source: https://topvisor.com/ru/api/v2-services/content_2/apometr/

Получает историю шторма за период в 2 суток.

```APIDOC
## [GET] apometr/history

### Description
Получает историю шторма за период в 2 суток.

### Method
GET

### Endpoint
apometr/history
```

--------------------------------

### get: profile/avatar

Source: https://topvisor.com/ru/api/v2-services/users_2/profile/

Retrieves the current user avatar.

```APIDOC
## get: profile/avatar

### Description
Retrieves the current user avatar.

### Method
get

### Endpoint
users_2/account/get: profile/avatar

### Parameters
No parameters documented.

### Request Example
No request example provided.

### Response
No response details provided.
```

--------------------------------

### Пример SDK на PHP: получение ключевых слов с полями

Source: https://topvisor.com/ru/api/v2/basic-params/fields/

PHP-код с использованием SDK Topvisor для получения списка ключевых слов с указанием полей id, name, group_name. Требуется указать ID проекта в переменной $projectId.

```php
	<?php

	$projectId = '%NN%'; // ID of your project

	$TVSession = new TV\Session();

	$selectorKeywords = new TV\Pen($TVSession, 'get', 'keywords_2', 'keywords');
	$selectorKeywords->setData(['project_id' => $project_id]);
	$selectorKeywords->setFields(['id', 'name', 'group_name']);

	$page = $selectorKeywords->exec();
	if(is_null($page->getResult())) return var_dump($page->getErrors());

	// $page - array of keywords
	foreach($page->getResult() as $resultItem){
		var_dump($resultItem);
	}
```

--------------------------------

### Pen::exec

Source: https://topvisor.com/ru/api/v2/sdk-php/pen/

Executes the API request and returns a page object containing the response data.

```APIDOC
## exec()

### Description
Executes the API request and returns a page object containing the response data.

### Method
exec

### Parameters
None

### Return Value
- **page** (object) - The response object containing the API result.

### Example
```php
$page = $selectorKeywords->exec();
```
```

--------------------------------

### GET /schedule_2/settings

Source: https://topvisor.com/ru/api/v2-services/schedule_2/settings/

Retrieves the current additional settings for the automatic operation schedule in a project.

```APIDOC
## [GET] /schedule_2/settings

### Description
Retrieves the current additional settings for the automatic operation schedule in a project.

### Method
GET

### Endpoint
/schedule_2/settings
```

--------------------------------

### Authentication Headers

Source: https://topvisor.com/ru/api/v2/intro/

Authentication is performed using the User-Id and Authorization headers. The Authorization header must contain the API key in bearer token format.

```APIDOC
## Authentication Headers

### Description
To authenticate API requests, you must include the User-Id and Authorization headers. The Authorization header uses the bearer token format with your API key.

### Headers
- **User-Id** (string) - Required - Your user ID
- **Authorization** (string) - Required - Bearer token with your API key, format: `bearer %USER_API_KEY%`

### Example
```http
User-Id: %USER_ID%
Authorization: bearer %USER_API_KEY%
```
```

--------------------------------

### get

Source: https://topvisor.com/ru/api/v2-services/tpvsr_2/short_link/

Retrieves information about short links. This method returns the short link objects with their details.

```APIDOC
## get

### Description
Retrieves information about short links.

### Method
get

### Endpoint
Not specified

### Parameters
None explicitly documented.

### Response
#### Success Response
Returns a list of short link objects with fields: short_link, link, user_id, create, title, favorite, deleted, hash, count, tags.

#### Response Example
Not provided.
```

--------------------------------

### getMessages()

Source: https://topvisor.com/ru/api/v2/sdk-php/page/

Returns an array with informational messages.

```APIDOC
## getMessages()

### Description
Returns an array with informational messages.

### Method
getMessages

### Parameters
None

### Return Value
- **array** - An array of informational messages.
```

--------------------------------

### get: stat

Source: https://topvisor.com/ru/api/v2-services/tpvsr_2/short_link/

Retrieves statistics of clicks for a short link. This method provides click count and related statistics.

```APIDOC
## get: stat

### Description
Retrieves statistics of clicks for a short link.

### Method
get: stat

### Endpoint
Not specified

### Parameters
None explicitly documented.

### Response
#### Success Response
Returns statistics data for the short link.

#### Response Example
Not provided.
```

--------------------------------

### getErrorsString()

Source: https://topvisor.com/ru/api/v2/sdk-php/page/

Returns all errors from the API in a single string.

```APIDOC
## getErrorsString()

### Description
Returns all errors from the API in a single string.

### Method
getErrorsString

### Parameters
None

### Return Value
- **string** - A string containing all errors.
```

--------------------------------

### new TV\Session(['userId' => $userId, 'accessToken' => $accessToken])

Source: https://topvisor.com/ru/api/v2/sdk-php/session/

Creates a session object with custom authentication parameters. The $auth array must contain userId and accessToken, where accessToken is the API Key.

```APIDOC
## new TV\Session(['userId' => $userId, 'accessToken' => $accessToken])

### Description
Creates a session object with custom authentication parameters. The $auth array must contain userId and accessToken, where accessToken is the API Key.

### Method
Constructor

### Endpoint
TV\Session::__construct($auth = null)

### Parameters
#### Constructor Parameters
- **$auth** (array) - Required - Must contain two elements: userId and accessToken.
  - **userId** (string|int) - Required - The user ID.
  - **accessToken** (string) - Required - The API Key.

### Request Example
```php
<?php
//...
$Session_2 = new TV\Session(['userId' => $userId, 'accessToken' => $accessToken]);
//...
```

### Response
#### Success Response
Returns a TV\Session object.

#### Response Example
```php
$Session_2 = new TV\Session(['userId' => $userId, 'accessToken' => $accessToken]);
```
```

--------------------------------

### edit/audit_2/sitemap/checker/go

Source: https://topvisor.com/ru/api/v2-services/audit_2/sitemap/edit-sitemap_checker_go/

Starts generation of a sitemap in the project. This method is part of the Audit service (audit_2) and is used to trigger sitemap generation for specified projects.

```APIDOC
## [POST] edit/audit_2/sitemap/checker/go

### Description
Starts generation of a sitemap in the project.

### Method
POST

### Endpoint
edit/audit_2/sitemap/checker/go

### Parameters
#### Request Body
- **filters** (array filters of projects) - Required - Criterion for filtering projects
- **max_pages** (enum(100, 1000, 10000, 100000, 150000, 300000)) - Required - Maximum number of pages for sitemap generation

### Response
#### Success Response (200)
- **result** (object) - Contains the result of the operation
  - **projectsIds** (array(int)) - IDs of projects sent for sitemap generation

#### Response Example
{
  "result": {
    "projectsIds": [123, 456]
  }
}
```

--------------------------------

### getNextOffset()

Source: https://topvisor.com/ru/api/v2/sdk-php/page/

Returns the next offset for paginated fetching. If this is the last page, returns null.

```APIDOC
## getNextOffset()

### Description
Returns the next offset for paginated fetching. If this is the last page, returns null.

### Method
getNextOffset

### Parameters
None

### Return Value
- **int|null** - The next offset, or null if this is the last page.
```

--------------------------------

### GET /audit_2/sitemap/checker/price

Source: https://topvisor.com/ru/api/v2-services/audit_2/sitemap/get-sitemap_checker_price/

Retrieves the cost of generating a sitemap. This method returns the price for sitemap generation based on the provided filters and maximum number of pages.

```APIDOC
## [GET] /audit_2/sitemap/checker/price

### Description
Retrieves the cost of generating a sitemap.

### Method
GET

### Endpoint
/audit_2/sitemap/checker/price

### Parameters
#### Required Parameters
- **filters** (array filters of projects) - Required - Criteria for filtering projects
- **max_pages** (enum(100, 1000, 10000, 100000, 150000, 300000)) - Required - Maximum number of pages for sitemap generation

#### Optional Parameters
- **apply_discount** (boolean) - Optional - Return the amount with discount applied. Default: 1

### Response
#### Success Response
- **result** (int) - Cost of sitemap generation

#### Response Example
{
  "result": 100
}
```

--------------------------------

### Pen::setOffset

Source: https://topvisor.com/ru/api/v2/sdk-php/pen/

Sets the 'offset' parameter for the API request, specifying the starting point for returned records.

```APIDOC
## setOffset(int $offset)

### Description
Sets the 'offset' parameter for the API request, specifying the starting point for returned records.

### Method
setOffset

### Parameters
- **$offset** (int) - Required - The number of records to skip before starting to return results.

### Example
```php
$selectorKeywords->setOffset(20);
```
```

--------------------------------

### getHeaders()

Source: https://topvisor.com/ru/api/v2/sdk-php/page/

Returns an array with the response headers from the API server.

```APIDOC
## getHeaders()

### Description
Returns an array with the response headers from the API server.

### Method
getHeaders

### Parameters
None

### Return Value
- **array** - An array of response headers.
```
Tokens:
Raw