All URIs are relative to https://api.criteo.com, except if the operation defines another base path.
Method | HTTP request | Description |
---|---|---|
generateAsyncAccountsReport() | POST /preview/retail-media/reports/accounts | |
generateAsyncCampaignsReport() | POST /preview/retail-media/reports/campaigns | |
generateAsyncLineItemsReport() | POST /preview/retail-media/reports/line-items | |
generateSyncAttributedTransactionsReport() | POST /preview/retail-media/reports/sync/attributed-transactions | |
generateSyncCampaignsReport() | POST /preview/retail-media/reports/sync/campaigns | |
generateSyncLineItemsReport() | POST /preview/retail-media/reports/sync/line-items | |
getAsyncExportOutput() | GET /preview/retail-media/reports/{reportId}/output | |
getAsyncExportStatus() | GET /preview/retail-media/reports/{reportId}/status |
generateAsyncAccountsReport($async_accounts_report_request): \criteo\api\retailmedia\preview\Model\AsyncReportResponse
Returns an asynchronous Accounts Report This endpoint is subject to specific rate limits.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new criteo\api\retailmedia\preview\Api\AnalyticsApi(
// 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
);
$async_accounts_report_request = new \criteo\api\retailmedia\preview\Model\AsyncAccountsReportRequest(); // \criteo\api\retailmedia\preview\Model\AsyncAccountsReportRequest
try {
$result = $apiInstance->generateAsyncAccountsReport($async_accounts_report_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AnalyticsApi->generateAsyncAccountsReport: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
async_accounts_report_request | \criteo\api\retailmedia\preview\Model\AsyncAccountsReportRequest |
\criteo\api\retailmedia\preview\Model\AsyncReportResponse
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
generateAsyncCampaignsReport($async_campaigns_report_request): \criteo\api\retailmedia\preview\Model\AsyncReportResponse
Return an asynchronous Campaigns Report This endpoint is subject to specific rate limits.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new criteo\api\retailmedia\preview\Api\AnalyticsApi(
// 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
);
$async_campaigns_report_request = new \criteo\api\retailmedia\preview\Model\AsyncCampaignsReportRequest(); // \criteo\api\retailmedia\preview\Model\AsyncCampaignsReportRequest
try {
$result = $apiInstance->generateAsyncCampaignsReport($async_campaigns_report_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AnalyticsApi->generateAsyncCampaignsReport: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
async_campaigns_report_request | \criteo\api\retailmedia\preview\Model\AsyncCampaignsReportRequest |
\criteo\api\retailmedia\preview\Model\AsyncReportResponse
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
generateAsyncLineItemsReport($async_line_items_report_request): \criteo\api\retailmedia\preview\Model\AsyncReportResponse
Returns an asynchronous Line Items Report This endpoint is subject to specific rate limits.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new criteo\api\retailmedia\preview\Api\AnalyticsApi(
// 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
);
$async_line_items_report_request = new \criteo\api\retailmedia\preview\Model\AsyncLineItemsReportRequest(); // \criteo\api\retailmedia\preview\Model\AsyncLineItemsReportRequest
try {
$result = $apiInstance->generateAsyncLineItemsReport($async_line_items_report_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AnalyticsApi->generateAsyncLineItemsReport: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
async_line_items_report_request | \criteo\api\retailmedia\preview\Model\AsyncLineItemsReportRequest |
\criteo\api\retailmedia\preview\Model\AsyncReportResponse
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
generateSyncAttributedTransactionsReport($sync_attributed_transactions_report_request): \criteo\api\retailmedia\preview\Model\ReportResponse
Returns a synchronous Attributed Transactions Report
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new criteo\api\retailmedia\preview\Api\AnalyticsApi(
// 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
);
$sync_attributed_transactions_report_request = new \criteo\api\retailmedia\preview\Model\SyncAttributedTransactionsReportRequest(); // \criteo\api\retailmedia\preview\Model\SyncAttributedTransactionsReportRequest
try {
$result = $apiInstance->generateSyncAttributedTransactionsReport($sync_attributed_transactions_report_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AnalyticsApi->generateSyncAttributedTransactionsReport: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
sync_attributed_transactions_report_request | \criteo\api\retailmedia\preview\Model\SyncAttributedTransactionsReportRequest |
\criteo\api\retailmedia\preview\Model\ReportResponse
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
generateSyncCampaignsReport($sync_campaigns_report_request): \criteo\api\retailmedia\preview\Model\ReportResponse
Returns a synchronous Campaigns Report
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new criteo\api\retailmedia\preview\Api\AnalyticsApi(
// 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
);
$sync_campaigns_report_request = new \criteo\api\retailmedia\preview\Model\SyncCampaignsReportRequest(); // \criteo\api\retailmedia\preview\Model\SyncCampaignsReportRequest
try {
$result = $apiInstance->generateSyncCampaignsReport($sync_campaigns_report_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AnalyticsApi->generateSyncCampaignsReport: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
sync_campaigns_report_request | \criteo\api\retailmedia\preview\Model\SyncCampaignsReportRequest |
\criteo\api\retailmedia\preview\Model\ReportResponse
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
generateSyncLineItemsReport($sync_line_items_report_request): \criteo\api\retailmedia\preview\Model\ReportResponse
Returns a synchronous Line Items Report
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new criteo\api\retailmedia\preview\Api\AnalyticsApi(
// 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
);
$sync_line_items_report_request = new \criteo\api\retailmedia\preview\Model\SyncLineItemsReportRequest(); // \criteo\api\retailmedia\preview\Model\SyncLineItemsReportRequest
try {
$result = $apiInstance->generateSyncLineItemsReport($sync_line_items_report_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AnalyticsApi->generateSyncLineItemsReport: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
sync_line_items_report_request | \criteo\api\retailmedia\preview\Model\SyncLineItemsReportRequest |
\criteo\api\retailmedia\preview\Model\ReportResponse
- Content-Type:
application/json-patch+json
,application/json
,text/json
,application/*+json
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getAsyncExportOutput($report_id): string
Returns the output of an async report
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new criteo\api\retailmedia\preview\Api\AnalyticsApi(
// 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
);
$report_id = 'report_id_example'; // string | The ID of the report to retrieve
try {
$result = $apiInstance->getAsyncExportOutput($report_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AnalyticsApi->getAsyncExportOutput: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
report_id | string | The ID of the report to retrieve |
string
- Content-Type: Not defined
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getAsyncExportStatus($report_id): \criteo\api\retailmedia\preview\Model\AsyncReportResponse
Returns the status of an async report
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth
$config = criteo\api\retailmedia\preview\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new criteo\api\retailmedia\preview\Api\AnalyticsApi(
// 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
);
$report_id = 'report_id_example'; // string | The ID of the report to retrieve
try {
$result = $apiInstance->getAsyncExportStatus($report_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AnalyticsApi->getAsyncExportStatus: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
report_id | string | The ID of the report to retrieve |
\criteo\api\retailmedia\preview\Model\AsyncReportResponse
- Content-Type: Not defined
- Accept:
text/plain
,application/json
,text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]