QuantClient\CrawlersApi

All URIs are relative to https://dashboard.quantcdn.io, except if the operation defines another base path.

Method	HTTP request	Description
crawlersCreate()	POST /api/v2/organizations/{organization}/projects/{project}/crawlers	Create a new crawler
crawlersDelete()	DELETE /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}	Delete a crawler
crawlersGetRunById()	GET /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/runs/{run_id}	Get a run by ID
crawlersGetRuns()	GET /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/runs	Get all runs for a crawler
crawlersList()	GET /api/v2/organizations/{organization}/projects/{project}/crawlers	List crawlers for the project
crawlersRead()	GET /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}	Get details of a single crawler
crawlersRun()	POST /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/run	Run a crawler
crawlersUpdate()	PATCH /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}	Update a crawler

`crawlersCreate()`

crawlersCreate($organization, $project, $v2_crawler_request): \QuantClient\Model\V2Crawler

Create a new crawler

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: BearerAuth
$config = QuantClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new QuantClient\Api\CrawlersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier
$v2_crawler_request = new \QuantClient\Model\V2CrawlerRequest(); // \QuantClient\Model\V2CrawlerRequest

try {
    $result = $apiInstance->crawlersCreate($organization, $project, $v2_crawler_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CrawlersApi->crawlersCreate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
organization	string	Organization identifier
project	string	Project identifier
v2_crawler_request	\QuantClient\Model\V2CrawlerRequest

Return type

\QuantClient\Model\V2Crawler

Authorization

BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`crawlersDelete()`

crawlersDelete($organization, $project, $crawler)

Delete a crawler

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: BearerAuth
$config = QuantClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new QuantClient\Api\CrawlersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier
$crawler = 00000000-0000-0000-0000-000000000000; // string | The UUID of the crawler

try {
    $apiInstance->crawlersDelete($organization, $project, $crawler);
} catch (Exception $e) {
    echo 'Exception when calling CrawlersApi->crawlersDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
organization	string	Organization identifier
project	string	Project identifier
crawler	string	The UUID of the crawler

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`crawlersGetRunById()`

crawlersGetRunById($organization, $project, $crawler, $run_id): \QuantClient\Model\V2CrawlerRun

Get a run by ID

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: BearerAuth
$config = QuantClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new QuantClient\Api\CrawlersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier
$crawler = 00000000-0000-0000-0000-000000000000; // string | Crawler identifier
$run_id = 1; // int | Run identifier

try {
    $result = $apiInstance->crawlersGetRunById($organization, $project, $crawler, $run_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CrawlersApi->crawlersGetRunById: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
organization	string	Organization identifier
project	string	Project identifier
crawler	string	Crawler identifier
run_id	int	Run identifier

Return type

\QuantClient\Model\V2CrawlerRun

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`crawlersGetRuns()`

crawlersGetRuns($organization, $project, $crawler): \QuantClient\Model\V2CrawlerRun[]

Get all runs for a crawler

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: BearerAuth
$config = QuantClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new QuantClient\Api\CrawlersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier
$crawler = 00000000-0000-0000-0000-000000000000; // string | Crawler identifier

try {
    $result = $apiInstance->crawlersGetRuns($organization, $project, $crawler);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CrawlersApi->crawlersGetRuns: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
organization	string	Organization identifier
project	string	Project identifier
crawler	string	Crawler identifier

Return type

\QuantClient\Model\V2CrawlerRun[]

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`crawlersList()`

crawlersList($organization, $project)

List crawlers for the project

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: BearerAuth
$config = QuantClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new QuantClient\Api\CrawlersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier

try {
    $apiInstance->crawlersList($organization, $project);
} catch (Exception $e) {
    echo 'Exception when calling CrawlersApi->crawlersList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
organization	string	Organization identifier
project	string	Project identifier

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`crawlersRead()`

crawlersRead($organization, $project, $crawler): \QuantClient\Model\V2Crawler

Get details of a single crawler

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: BearerAuth
$config = QuantClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new QuantClient\Api\CrawlersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier
$crawler = 00000000-0000-0000-0000-000000000000; // string | The UUID of the crawler

try {
    $result = $apiInstance->crawlersRead($organization, $project, $crawler);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CrawlersApi->crawlersRead: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
organization	string	Organization identifier
project	string	Project identifier
crawler	string	The UUID of the crawler

Return type

\QuantClient\Model\V2Crawler

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`crawlersRun()`

crawlersRun($organization, $project, $crawler, $crawlers_run_request): \QuantClient\Model\CrawlersRun200Response

Run a crawler

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: BearerAuth
$config = QuantClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new QuantClient\Api\CrawlersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier
$crawler = 00000000-0000-0000-0000-000000000000; // string | Crawler identifier
$crawlers_run_request = new \QuantClient\Model\CrawlersRunRequest(); // \QuantClient\Model\CrawlersRunRequest

try {
    $result = $apiInstance->crawlersRun($organization, $project, $crawler, $crawlers_run_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CrawlersApi->crawlersRun: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
organization	string	Organization identifier
project	string	Project identifier
crawler	string	Crawler identifier
crawlers_run_request	\QuantClient\Model\CrawlersRunRequest		[optional]

Return type

\QuantClient\Model\CrawlersRun200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`crawlersUpdate()`

crawlersUpdate($organization, $project, $crawler, $v2_crawler_request): \QuantClient\Model\V2Crawler

Update a crawler

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: BearerAuth
$config = QuantClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new QuantClient\Api\CrawlersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier
$crawler = 00000000-0000-0000-0000-000000000000; // string | The UUID of the crawler
$v2_crawler_request = new \QuantClient\Model\V2CrawlerRequest(); // \QuantClient\Model\V2CrawlerRequest

try {
    $result = $apiInstance->crawlersUpdate($organization, $project, $crawler, $v2_crawler_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CrawlersApi->crawlersUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
organization	string	Organization identifier
project	string	Project identifier
crawler	string	The UUID of the crawler
v2_crawler_request	\QuantClient\Model\V2CrawlerRequest

Return type

\QuantClient\Model\V2Crawler

Authorization

BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Uh oh!

FilesExpand file tree

CrawlersApi.md

Latest commit

History

CrawlersApi.md

File metadata and controls

QuantClient\CrawlersApi

crawlersCreate()

Example

Parameters

Return type

Authorization

HTTP request headers

crawlersDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

crawlersGetRunById()

Example

Parameters

Return type

Authorization

HTTP request headers

crawlersGetRuns()

Example

Parameters

Return type

Authorization

HTTP request headers

crawlersList()

Example

Parameters

Return type

Authorization

HTTP request headers

crawlersRead()

Example

Parameters

Return type

Authorization

HTTP request headers

crawlersRun()

Example

Parameters

Return type

Authorization

HTTP request headers

crawlersUpdate()

Example

Parameters

Return type

Authorization

HTTP request headers

`crawlersCreate()`

`crawlersDelete()`

`crawlersGetRunById()`

`crawlersGetRuns()`

`crawlersList()`

`crawlersRead()`

`crawlersRun()`

`crawlersUpdate()`