TikTok Marketing API Reporting API
The Reporting API from TikTok Marketing API — 7 operation(s) for reporting.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/tiktok-ads-reporting-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: TikTok API for Business — Marketing Reporting API
description: TikTok API for Business (Marketing API) v1.3. This document is a mechanical union of the 202 per-operation OpenAPI 3.0.1 documents TikTok publishes in yml_files/ of its own SDK repository (https://github.com/tiktok/tiktok-business-api-sdk), which are the swagger-codegen inputs for TikTok's first-party Java/Python/JavaScript SDKs. Operation content (paths, parameters, responses, tags and the x-open-* extensions) is preserved verbatim; only info, servers and components.securitySchemes were written by API Evangelist, because the per-operation fragments carry placeholder info blocks and no servers block. The servers values are the production and sandbox base URLs TikTok documents at https://business-api.tiktok.com/portal/docs?id=1738855331457026 .
version: v1.3
contact:
name: TikTok API for Business support
url: https://business-api.tiktok.com/portal/docs?id=1795190020378625
termsOfService: https://business-api.tiktok.com/portal/docs?id=1737191804348417
x-source: https://github.com/tiktok/tiktok-business-api-sdk/tree/main/yml_files
x-harvested-by: API Evangelist enrichment pipeline
x-harvested: '2026-08-13'
servers:
- url: https://business-api.tiktok.com/open_api/v1.3
description: Production
- url: https://sandbox-ads.tiktok.com/open_api/v1.3
description: Sandbox
security:
- AccessToken: []
tags:
- name: Reporting
paths:
/gmv_max/report/get/:
get:
operationId: Gmv_max Report Get
parameters:
- description: ''
in: query
name: advertiser_id
required: true
schema:
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-convert:
- int64(%s)
x-open-source: $.http.query.advertiser_id
x-open-field-id: 1
- content:
application/json:
schema:
items:
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-convert:
- int64(%s)
maxItems: 1
minItems: 1
type: array
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-source: $.http.query.store_ids
description: ''
in: query
name: store_ids
required: true
x-open-field-id: 2
- content:
application/json:
schema:
items:
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
maxItems: 3
type: array
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-source: $.http.query.dimensions
description: ''
in: query
name: dimensions
required: true
x-open-field-id: 3
- content:
application/json:
schema:
items:
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
maxItems: 100
type: array
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-source: $.http.query.metrics
description: ''
in: query
name: metrics
required: true
x-open-field-id: 4
- description: ''
in: query
name: enable_total_metrics
required: false
schema:
default: false
type: boolean
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-source: $.http.query.enable_total_metrics
x-open-field-id: 5
- description: ''
in: query
name: start_date
required: true
schema:
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-source: $.http.query.start_date
x-open-field-id: 6
- description: ''
in: query
name: end_date
required: true
schema:
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-source: $.http.query.end_date
x-open-field-id: 7
- content:
application/json:
schema:
properties:
campaign_ids:
description: ''
items:
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-convert:
- int64(%s)
maxItems: 100
type: array
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-field-id: 1
x-open-source: $.http.query.filtering.campaign_ids
campaign_name:
description: ''
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-field-id: 2
x-open-source: $.http.query.filtering.campaign_name
campaign_statuses:
description: ''
items:
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-enum:
enum_package_expired: false
enum_package_id: null
enum_package_name: null
enums:
- description: ''
is_valid: true
key: STATUS_DELETE
value: delete
- description: ''
is_valid: true
key: STATUS_DELIVERY_OK
value: delivery_ok
- description: ''
is_valid: true
key: STATUS_DISABLE
value: disable
- description: ''
is_valid: true
key: STATUS_NOT_DELIVERY
value: not_delivery
key_format: string
strict: true
use_part: false
validate_only: false
value_format: string
maxItems: 4
type: array
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-field-id: 3
x-open-source: $.http.query.filtering.campaign_statuses
creative_delivery_statuses:
description: ''
items:
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-enum:
enum_package_expired: false
enum_package_id: null
enum_package_name: null
enums:
- description: ''
is_valid: true
key: IN_QUEUE
value: '1'
- description: ''
is_valid: true
key: LEARNING
value: '2'
- description: ''
is_valid: true
key: DELIVERING
value: '3'
- description: ''
is_valid: true
key: NOT_DELIVERYING
value: '4'
- description: ''
is_valid: true
key: AUTHORIZATION_NEEDED
value: '5'
- description: ''
is_valid: true
key: EXCLUDED
value: '6'
- description: ''
is_valid: true
key: UNAVAILABLE
value: '7'
- description: ''
is_valid: true
key: REJECTED
value: '9'
- description: ''
is_valid: true
key: NOT_ACTIVE
value: '10'
key_format: string
strict: true
use_part: false
validate_only: false
value_format: int32
type: array
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-field-id: 10
creative_types:
description: ''
items:
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-enum:
enum_package_expired: false
enum_package_id: null
enum_package_name: null
enums:
- description: ''
is_valid: true
key: ADS_AND_ORGANIC
value: '1'
- description: ''
is_valid: true
key: ORGANIC
value: '2'
- description: ''
is_valid: true
key: REMOVED
value: '3'
key_format: string
strict: true
use_part: false
validate_only: false
value_format: int32
maxItems: 1
type: array
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-field-id: 6
x-open-source: $.http.query.filtering.creative_types
gmv_max_promotion_types:
description: ''
items:
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-enum:
enum_package_expired: false
enum_package_id: null
enum_package_name: null
enums:
- description: ''
is_valid: true
key: PRODUCT
value: '0'
- description: ''
is_valid: true
key: LIVE
value: '1'
key_format: string
strict: true
use_part: false
validate_only: false
value_format: int32
maxItems: 2
type: array
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-field-id: 5
x-open-source: $.http.query.filtering.gmv_max_promotion_types
item_group_ids:
description: ''
items:
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
maxItems: 100
type: array
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-field-id: 4
x-open-source: $.http.query.filtering.item_group_ids
item_ids:
description: ''
items:
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
maxItems: 100
type: array
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-field-id: 7
x-open-source: $.http.query.filtering.item_ids
room_ids:
description: ''
items:
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
maxItems: 100
type: array
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-field-id: 8
x-open-source: $.http.query.filtering.room_ids
search_word:
description: ''
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-field-id: 9
x-open-source: $.http.query.filtering.search_word
type: object
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-source: $.http.query.filtering
description: ''
in: query
name: filtering
required: false
x-open-field-id: 8
- description: ''
in: query
name: sort_field
required: false
schema:
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-source: $.http.query.sort_field
x-open-field-id: 9
- description: ''
in: query
name: sort_type
required: false
schema:
default: DESC
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-enum:
enum_package_expired: false
enum_package_id: null
enum_package_name: null
enums:
- description: ''
is_valid: true
key: ASC
value: '0'
- description: ''
is_valid: true
key: DESC
value: '1'
key_format: string
strict: true
use_part: false
validate_only: false
value_format: int32
x-open-source: $.http.query.sort_type
x-open-field-id: 10
- description: ''
in: query
name: page
required: false
schema:
default: 1
format: int64
type: integer
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-source: $.http.query.page
x-open-field-id: 11
- description: ''
in: query
name: page_size
required: false
schema:
default: 10
format: int64
maximum: 1000
type: integer
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-source: $.http.query.page_size
x-open-field-id: 12
- content:
application/json:
schema:
properties:
app_id:
description: ''
format: int64
type: integer
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-field-id: 1
x-open-source: $.http.query.context_info.app_id
core_user_id:
description: ''
format: int64
type: integer
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-field-id: 2
x-open-source: $.http.query.context_info.core_user_id
developer_id:
description: ''
format: int64
type: integer
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-field-id: 3
x-open-source: $.http.query.context_info.developer_id
referer:
description: ''
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-field-id: 7
x-open-source: $.http.query.context_info.referer
user_agent:
description: ''
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-field-id: 6
x-open-source: $.http.query.context_info.user_agent
x_forwarded_for:
description: ''
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-field-id: 4
x-open-source: $.http.query.context_info.x_forwarded_for
x_real_ip:
description: ''
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-field-id: 5
x-open-source: $.http.query.context_info.x_real_ip
type: object
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-source: $.http.query.context_info
description: ''
in: query
name: context_info
required: false
x-open-field-id: 13
- description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
in: query
name: Access-Token
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
properties:
code:
description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request.
format: int64
type:
- integer
- 'null'
x-open-allow-strlist: false
x-open-field-id: 4
data:
description: Returned data. The response for the SDK can be checked in the document for the API given in the description.
properties: {}
type:
- object
- 'null'
x-open-allow-strlist: false
x-open-field-id: 1
x-open-source: $.rpc.output.data
message:
description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097).
type:
- string
- 'null'
x-open-allow-strlist: false
x-open-field-id: 3
request_id:
description: The log ID of a request, which uniquely identifies the request.
type:
- string
- 'null'
x-open-allow-strlist: false
x-open-field-id: 2
type: object
x-open-allow-strlist: false
description: OK
summary: Get GMV Max report [Smart Plus GMV Max Report Get](https://business-api.tiktok.com/portal/docs?id=1824721673497601)
tags:
- Reporting
x-open-allowlist: {}
x-open-denylist: {}
x-open-rules:
base_rule: null
extra_rule:
base_source: []
http_query_source: []
http_source:
- name: advertiser_id
required: true
source: $.http.query.advertiser_id
type: number
- children:
- type: number
is_expand: true
name: store_ids
required: true
source: $.http.query.store_ids
sub_type: number
type: array
- children:
- type: string
is_expand: true
name: dimensions
required: true
source: $.http.query.dimensions
sub_type: string
type: array
- children:
- type: string
is_expand: true
name: metrics
required: false
source: $.http.query.metrics
sub_type: string
type: array
- name: enable_total_metrics
required: false
source: $.http.query.enable_total_metrics
type: boolean
- name: start_date
required: true
source: $.http.query.start_date
type: string
- name: end_date
required: true
source: $.http.query.end_date
type: string
- children:
- children:
- type: number
is_expand: true
name: campaign_ids
required: false
source: $.http.query.filtering.campaign_ids
sub_type: number
type: array
- name: campaign_name
required: false
source: $.http.query.filtering.campaign_name
type: string
- children:
- type: string
is_expand: true
name: campaign_statuses
required: false
source: $.http.query.filtering.campaign_statuses
sub_type: string
type: array
- children:
- type: string
is_expand: true
name: item_group_ids
required: false
source: $.http.query.filtering.item_group_ids
sub_type: string
type: array
- children:
- type: number
is_expand: true
name: gmv_max_promotion_types
required: false
source: $.http.query.filtering.gmv_max_promotion_types
sub_type: number
type: array
- children:
- type: number
is_expand: true
name: creative_types
required: false
source: $.http.query.filtering.creative_types
sub_type: number
type: array
- children:
- type: string
is_expand: true
name: item_ids
required: false
source: $.http.query.filtering.item_ids
sub_type: string
type: array
- children:
- type: string
is_expand: true
name: room_ids
required: false
source: $.http.query.filtering.room_ids
sub_type: string
type: array
- name: search_word
required: false
source: $.http.query.filtering.search_word
type: string
- children:
- is_expand: false
source: undefined
type: number
is_expand: false
name: creative_delivery_statuses
required: false
source: $.http.query.filtering.creative_delivery_statuses
sub_type: number
type: array
is_expand: true
name: filtering
required: false
type: object
- name: sort_field
required: false
source: $.http.query.sort_field
type: string
- name: sort_type
required: false
source: $.http.query.sort_type
type: number
- name: page
required: false
source: $.http.query.page
type: number
- name: page_size
required: false
source: $.http.query.page_size
type: number
- children:
- name: app_id
required: false
source: $.context.app_id
type: number
- name: core_user_id
required: false
source: $.context.core_user_id
type: number
- name: developer_id
required: false
source: $.context.developer_id
type: number
- name: x_forwarded_for
required: false
source: $.context.source_ip
type: string
- name: x_real_ip
required: false
source: $.context.source_ip
type: string
- name: user_agent
required: false
source: $.context.is_same_identity
type: string
- name: referer
required: false
source: $.context.is_same_identity
type: string
is_expand: true
name: context_info
required: true
type: object
plugins:
after_response: []
before_request: []
request_query_rule: null
request_rule:
advertiser_id: $.http.query.advertiser_id
context_info:
app_id: $.context.app_id
core_user_id: $.context.core_user_id
developer_id: $.context.developer_id
referer: $.context.is_same_identity
user_agent: $.context.is_same_identity
x_forwarded_for: $.context.source_ip
x_real_ip: $.context.source_ip
dimensions: $.http.query.dimensions
enable_total_metrics: $.http.query.enable_total_metrics
end_date: $.http.query.end_date
filtering:
campaign_ids: $.http.query.filtering.campaign_ids
campaign_name: $.http.query.filtering.campaign_name
campaign_statuses: $.http.query.filtering.campaign_statuses
creative_delivery_statuses: $.http.query.filtering.creative_delivery_statuses
creative_types: $.http.query.filtering.creative_types
gmv_max_promotion_types: $.http.query.filtering.gmv_max_promotion_types
item_group_ids: $.http.query.filtering.item_group_ids
item_ids: $.http.query.filtering.item_ids
room_ids: $.http.query.filtering.room_ids
search_word: $.http.query.filtering.search_word
metrics: $.http.query.metrics
page: $.http.query.page
page_size: $.http.query.page_size
sort_field: $.http.query.sort_field
sort_type: $.http.query.sort_type
start_date: $.http.query.start_date
store_ids: $.http.query.store_ids
response_cookie: []
response_header: []
response_rule:
list: $.rpc.output.stats
page_info: $.rpc.output.page_info
total_metrics: $.rpc.output.total_metrics
x-open-scene-labels: []
x-open-settings:
pop_resp_nullvalue: true
/report/integrated/get/:
get:
operationId: Report Integrated Get
parameters:
- description: ''
in: query
name: page
required: false
schema:
default: 1
format: int64
minimum: 1
type: integer
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-source: $.http.query.page
x-open-field-id: 1
- description: ''
in: query
name: page_size
required: false
schema:
default: 10
format: int64
maximum: 1000
minimum: 1
type: integer
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-source: $.http.query.page_size
x-open-field-id: 2
- description: ''
in: query
name: enable_total_metrics
required: false
schema:
default: false
type: boolean
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-source: $.http.query.enable_total_metrics
x-open-field-id: 3
- description: ''
in: query
name: multi_adv_report_in_utc_time
required: false
schema:
default: false
type: boolean
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-source: $.http.query.multi_adv_report_in_utc_time
x-open-field-id: 4
- description: ''
in: query
name: query_mode
required: false
schema:
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-enum:
enum_package_expired: false
enum_package_id: null
enum_package_name: null
enums:
- description: ''
is_valid: true
key: REGULAR
value: REGULAR
- description: ''
is_valid: true
key: CHUNK
value: CHUNK
key_format: string
strict: true
use_part: false
validate_only: false
value_format: string
x-open-source: $.http.query.query_mode
x-open-field-id: 5
- description: ''
in: query
name: advertiser_id
required: false
schema:
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-convert:
- int64(%s)
x-open-field-id: 6
- content:
application/json:
schema:
items:
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-convert:
- int64(%s)
type: array
x-open-allow-strlist: false
x-open-allow-strnum: false
description: ''
in: query
name: advertiser_ids
required: false
x-open-field-id: 7
- description: ''
in: query
name: bc_id
required: false
schema:
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-convert:
- int64(%s)
x-open-field-id: 8
- description: ''
in: query
name: service_type
required: false
schema:
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-enum:
enum_package_expired: false
enum_package_id: 1805686420337666
enum_package_name: ReportServiceType
enums:
- description: ''
is_valid: true
key: AUCTION
value: AUCTION
- description: ''
is_valid: true
key: RESERVATION
value: RESERVATION
key_format: string
strict: true
use_part: false
validate_only: false
value_format: string
x-open-field-id: 9
- description: ''
in: query
name: report_type
required: true
schema:
type: string
x-open-allow-strlist: false
x-open-allow-strnum: false
x-open-enum:
enum_package_expired: false
enum_package_id: 1807850604796929
enum_package_name: SyncReportType
enums:
- description: ''
is_valid: true
key: AUDIENCE
value: AUDIENCE
- description: ''
is_valid: true
key: BASIC
value: BASIC
- description: ''
is_valid: true
key: BC
value: BC
- description: ''
is_valid: true
key: CATALOG
value: CATALOG
- description: ''
is_valid: true
key: PLAYABLE_MATERIAL
value: PLAYABLE_MATERIAL
- description: ''
is_valid: true
key: TT
# --- truncated at 32 KB (680 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tiktok-ads/refs/heads/main/openapi/tiktok-ads-reporting-api-openapi.yml