keitaro-api-skill/references/paths/clicks_clean.yaml

59 lines
1.3 KiB
YAML

post:
tags:
- Clean stats
security:
- ApiKeyAuth: []
summary: Clean stats
description: Clean stats
requestBody:
description: Cleans the statistics
required: true
content:
application/json:
schema:
$ref: ../schemas/CleanRequest.yaml
responses:
'200':
description: Clean job successfully scheduled.
content:
application/json:
schema:
$ref: ../schemas/Success.yaml
'400':
$ref: ../responses/BadRequest.yaml
'401':
$ref: ../responses/Unauthorized.yaml
'402':
$ref: ../responses/PaymentRequired.yaml
'406':
$ref: ../responses/NotAcceptable.yaml
'500':
$ref: ../responses/InternalError.yaml
x-code-samples:
- lang: PHP
source: >-
$params = [
"start_date": "2017-04-01",
"end_date": "2017-04-10",
"timezone": "UTC"
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,
'http://example.com/admin_api/v1/clicks/clean');
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Api-Key: your-api-key'));
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
echo curl_exec($ch);