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

102 lines
2.4 KiB
YAML

get:
tags:
- Reports
security:
- ApiKeyAuth: []
summary: Get Labels
description: Get Labels
parameters:
- name: campaign_id
in: query
description: Campaign ID
required: true
schema:
type: integer
- name: label_name
in: query
description: Label name
required: true
schema:
type: string
- name: ref_name
in: query
description: |
<style>
.list-flex {
display: flex;
list-style: none;
flex-wrap: wrap;
}
.list-flex li {
width: 200px;
}
</style>
List of Available Ref Names:
<ul class="list-flex">
<li class="level1"><div class="li"> ip</div>
</li>
<li class="level1"><div class="li"> source</div>
</li>
<li class="level1"><div class="li"> ad_campaign_id</div>
</li>
<li class="level1"><div class="li"> creative_id</div>
</li>
<li class="level1"><div class="li"> keyword</div>
</li>
<li class="level1"><div class="li"> ad_campaign_idn</div>
</li>
<li class="level1"><div class="li"> sub_id_1..10</div>
</li>
</ul>
required: true
schema:
type: string
responses:
'200':
description: Labels
content:
application/json:
schema:
$ref: ../schemas/Labels.yaml
'400':
$ref: ../responses/BadRequest.yaml
'401':
$ref: ../responses/Unauthorized.yaml
'402':
$ref: ../responses/PaymentRequired.yaml
'404':
$ref: ../responses/NotFound.yaml
'500':
$ref: ../responses/InternalError.yaml
post:
tags:
- Reports
security:
- ApiKeyAuth: []
summary: Update Labels
description: Update Labels
requestBody:
description: Update Labels
required: true
content:
application/json:
schema:
$ref: ../schemas/LabelRequestPost.yaml
responses:
'200':
description: Labels
content:
application/json:
schema:
$ref: ../schemas/Success.yaml
'400':
$ref: ../responses/BadRequest.yaml
'401':
$ref: ../responses/Unauthorized.yaml
'402':
$ref: ../responses/PaymentRequired.yaml
'404':
$ref: ../responses/NotFound.yaml
'500':
$ref: ../responses/InternalError.yaml