Performance API (1.0)
Download OpenAPI specification:Download
External performance retrieval is divided into the following two lookup hierarchies.
- Creative hierarchy: ad account → campaign → ad group → creative
- Asset group hierarchy: ad account → campaign → asset group
Past performance is retrieved using the following two lookup hierarchies.
- Creative hierarchy: ad account → campaign → ad group → creative
- Asset group hierarchy: ad account → campaign → asset group
Results are aggregated from elements lower than the lookup unit, and performance is provided sorted in ascending order by date, by hour when retrieved hourly, and by the requested aggregation unit number.
The lookup period is up to 31 days, and data can be retrieved from 2 years ago up to the previous day. (Previous day's data becomes available from 02:00 today.)
Up to 1000 items can be retrieved at once, and paging is applied if the count exceeds this. Including the response's next field value as the next parameter in the next request retrieves the next page; this token is valid for 10 minutes.
When retrieving by asset group (assetGroups) unit, vplayCount is always 0.
Get past data of an ad account
Retrieves the past performance of a specific ad account, aggregated by campaign, ad group, creative, or asset group unit.
path Parameters
| aggregationType required | string Enum: "campaigns" "adSets" "creatives" "assetGroups" Performance aggregation unit (campaign: campaigns, ad group: adSets, creative: creatives, asset group: assetGroups) |
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| startDate required | string <date> Example: startDate=2023-01-01 Start date (yyyy-MM-dd) |
| endDate required | string <date> Example: endDate=2023-01-30 End date (yyyy-MM-dd) |
| next | string Example: next=zwMvjK6XRhyiJoFGZZkqhw:1707978058060 Next page token |
| limit | int Default: "1000" Number of records to get |
| timeUnit | string Default: "daily" Enum: "daily" "hourly" Interval for retrieving data (By day: daily, By hour: hourly) |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account number that has access to the performance data of the ad account |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "hour": "string",
- "impCount": 0,
- "clickCount": 0,
- "vplayCount": 0,
- "sales": 0.1
}
], - "next": "string"
}Get past data of a creative
Gets past performance data for a specific creative.
path Parameters
| creativeNo required | integer <int64> Example: 5678 Creative number |
| aggregationType required | string Value: "creatives" Performance data aggregation type (creatives: by creative) |
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| startDate required | string <date> Example: startDate=2023-01-01 Start date (yyyy-MM-dd) |
| endDate required | string <date> Example: endDate=2023-01-30 End date (yyyy-MM-dd) |
| next | string Example: next=zwMvjK6XRhyiJoFGZZkqhw:1707978058060 Next page token |
| limit | int Default: "1000" Number of records to get |
| timeUnit | string Default: "daily" Enum: "daily" "hourly" Interval for retrieving data (By day: daily, By hour: hourly) |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account number that has access to the performance data of the ad account |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "hour": "string",
- "impCount": 0,
- "clickCount": 0,
- "vplayCount": 0,
- "sales": 0.1
}
], - "next": "string"
}Get past data of a campaign
Retrieves the past performance of a specific campaign, aggregated by ad group, creative, or asset group unit.
path Parameters
| campaignNo required | integer <int64> Example: 5678 Campaign number |
| aggregationType required | string Enum: "adSets" "creatives" "assetGroups" Performance aggregation unit (ad group: adSets, creative: creatives, asset group: assetGroups) |
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| startDate required | string <date> Example: startDate=2023-01-01 Start date (yyyy-MM-dd) |
| endDate required | string <date> Example: endDate=2023-01-30 End date (yyyy-MM-dd) |
| next | string Example: next=zwMvjK6XRhyiJoFGZZkqhw:1707978058060 Next page token |
| limit | int Default: "1000" Number of records to get |
| timeUnit | string Default: "daily" Enum: "daily" "hourly" Interval for retrieving data (By day: daily, By hour: hourly) |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account number that has access to the performance data of the ad account |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "hour": "string",
- "impCount": 0,
- "clickCount": 0,
- "vplayCount": 0,
- "sales": 0.1
}
], - "next": "string"
}Get past data of an ad group
Gets past performance data for a specific ad group, aggregated by creative.
path Parameters
| adSetNo required | integer <int64> Example: 5678 Ad group number |
| aggregationType required | string Value: "creatives" Performance data aggregation type (creatives: by creative) |
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| startDate required | string <date> Example: startDate=2023-01-01 Start date (yyyy-MM-dd) |
| endDate required | string <date> Example: endDate=2023-01-30 End date (yyyy-MM-dd) |
| next | string Example: next=zwMvjK6XRhyiJoFGZZkqhw:1707978058060 Next page token |
| limit | int Default: "1000" Number of records to get |
| timeUnit | string Default: "daily" Enum: "daily" "hourly" Interval for retrieving data (By day: daily, By hour: hourly) |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account number that has access to the performance data of the ad account |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "hour": "string",
- "impCount": 0,
- "clickCount": 0,
- "vplayCount": 0,
- "sales": 0.1
}
], - "next": "string"
}Retrieve Asset Group Past Performance
Retrieves the past performance of a specific asset group.
path Parameters
| assetGroupNo required | integer <int64> Example: 5678 Asset group number |
| aggregationType required | string Value: "assetGroups" Performance aggregation unit (asset group: assetGroups) |
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| startDate required | string <date> Example: startDate=2023-01-01 Lookup start date (yyyy-MM-dd format) |
| endDate required | string <date> Example: endDate=2023-01-30 Lookup end date (yyyy-MM-dd format) |
| next | string Example: next=zwMvjK6XRhyiJoFGZZkqhw:1707978058060 Token for retrieving the next page |
| limit | int Default: "1000" Number of records to retrieve |
| timeUnit | string Default: "daily" Enum: "daily" "hourly" Lookup time unit (daily: daily, hourly: hourly) |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "hour": "string",
- "impCount": 0,
- "clickCount": 0,
- "vplayCount": 0,
- "sales": 0.1
}
], - "next": "string"
}Real-time performance is retrieved using the following two lookup hierarchies.
- Creative hierarchy: ad account → campaign → ad group → creative
- Asset group hierarchy: ad account → campaign → asset group
Today's or yesterday's data can be retrieved, and performance is provided sorted in ascending order based on the update time.
Including the response's until field value as the since parameter in the next request retrieves only performance updated after the previous response's until.
Even after the lookup time, real-time performance may change due to consistency verification and correction work.
When retrieving by asset group (assetGroups) unit, vplayCount is always 0.
Get real-time data of an ad account
Retrieves the real-time performance of a specific ad account by creative unit.
path Parameters
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| targetDate | string Default: "today" Enum: "today" "yesterday" Date (today or yesterday). |
| since | integer <int64> Example: since=1675907423000 Millisecond-unit timestamp for retrieving only performance updated after a specific point in time |
| timeUnit | string Default: "daily" Enum: "daily" "hourly" Interval for retrieving data (By day: daily, By hour: hourly) |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account number that has access to the performance data of the ad account |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "hour": "string",
- "impCount": 0,
- "clickCount": 0,
- "vplayCount": 0,
- "sales": 0.1
}
], - "until": 1675907423000
}Get real-time data of a creative
Gets real-time performance data for a specific creative.
path Parameters
| creativeNo required | integer <int64> Example: 5678 Creative number |
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| targetDate | string Default: "today" Enum: "today" "yesterday" Date (today or yesterday). |
| since | integer <int64> Example: since=1675907423000 Millisecond-unit timestamp for retrieving only performance updated after a specific point in time |
| timeUnit | string Default: "daily" Enum: "daily" "hourly" Interval for retrieving data (By day: daily, By hour: hourly) |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account number that has access to the performance data of the ad account |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "hour": "string",
- "impCount": 0,
- "clickCount": 0,
- "vplayCount": 0,
- "sales": 0.1
}
], - "until": 1675907423000
}Get real-time data of a campaign
Retrieves the real-time performance of a specific campaign by creative unit.
path Parameters
| campaignNo required | integer <int64> Example: 5678 Campaign number |
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| targetDate | string Default: "today" Enum: "today" "yesterday" Date (today or yesterday). |
| since | integer <int64> Example: since=1675907423000 Millisecond-unit timestamp for retrieving only performance updated after a specific point in time |
| timeUnit | string Default: "daily" Enum: "daily" "hourly" Interval for retrieving data (By day: daily, By hour: hourly) |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account number that has access to the performance data of the ad account |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "hour": "string",
- "impCount": 0,
- "clickCount": 0,
- "vplayCount": 0,
- "sales": 0.1
}
], - "until": 1675907423000
}Get real-time data of an ad group
Retrieves the real-time performance of a specific ad group by creative unit.
path Parameters
| adSetNo required | integer <int64> Example: 5678 Ad group number |
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| targetDate | string Default: "today" Enum: "today" "yesterday" Date (today or yesterday). |
| since | integer <int64> Example: since=1675907423000 Millisecond-unit timestamp for retrieving only performance updated after a specific point in time |
| timeUnit | string Default: "daily" Enum: "daily" "hourly" Interval for retrieving data (By day: daily, By hour: hourly) |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account number that has access to the performance data of the ad account |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "hour": "string",
- "impCount": 0,
- "clickCount": 0,
- "vplayCount": 0,
- "sales": 0.1
}
], - "until": 1675907423000
}Retrieve Campaign Real-Time Performance (Asset Group)
Retrieves the real-time performance of a specific campaign by asset group unit.
path Parameters
| campaignNo required | integer <int64> Example: 5678 Campaign number |
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| targetDate | string Default: "today" Enum: "today" "yesterday" Lookup target date (today: today, yesterday: yesterday) |
| since | integer <int64> Example: since=1675907423000 Millisecond-unit timestamp for retrieving only performance updated after a specific point in time |
| timeUnit | string Default: "daily" Enum: "daily" "hourly" Lookup time unit (daily: daily, hourly: hourly) |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "hour": "string",
- "impCount": 0,
- "clickCount": 0,
- "vplayCount": 0,
- "sales": 0.1
}
], - "until": 1675907423000
}Retrieve Ad Account Real-Time Performance (Asset Group)
Retrieves the real-time performance of a specific ad account by asset group unit.
path Parameters
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| targetDate | string Default: "today" Enum: "today" "yesterday" Lookup target date (today: today, yesterday: yesterday) |
| since | integer <int64> Example: since=1675907423000 Millisecond-unit timestamp for retrieving only performance updated after a specific point in time |
| timeUnit | string Default: "daily" Enum: "daily" "hourly" Lookup time unit (daily: daily, hourly: hourly) |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "hour": "string",
- "impCount": 0,
- "clickCount": 0,
- "vplayCount": 0,
- "sales": 0.1
}
], - "until": 1675907423000
}Retrieve Asset Group Real-Time Performance
Retrieves the real-time performance of a specific asset group.
path Parameters
| assetGroupNo required | integer <int64> Example: 5678 Asset group number |
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| targetDate | string Default: "today" Enum: "today" "yesterday" Lookup target date (today: today, yesterday: yesterday) |
| since | integer <int64> Example: since=1675907423000 Millisecond-unit timestamp for retrieving only performance updated after a specific point in time |
| timeUnit | string Default: "daily" Enum: "daily" "hourly" Lookup time unit (daily: daily, hourly: hourly) |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "hour": "string",
- "impCount": 0,
- "clickCount": 0,
- "vplayCount": 0,
- "sales": 0.1
}
], - "until": 1675907423000
}Past conversion performance is retrieved using the following two lookup hierarchies.
- Creative hierarchy: ad account → campaign → ad group → creative
- Asset group hierarchy: ad account → campaign → asset group
Results are aggregated from elements lower than the lookup unit, and performance is provided sorted in ascending order by date, by the requested aggregation unit number, and by conversion type.
The lookup period is up to 31 days, and data can be retrieved from 2 years ago up to the previous day. (Previous day's data becomes available from 02:00 today.)
Up to 1000 items can be retrieved at once, and paging is applied if the count exceeds this. Including the response's next field value as the next parameter in the next request retrieves the next page; this token is valid for 10 minutes.
Conversion performance does not support hourly lookup and is only available on a daily basis. For a description of the response's convType field, please refer to the 'Getting Started > Performance Management > Conversion Performance Lookup' page.
Get past conversion data of an ad account
Retrieves the past conversion performance of a specific ad account, aggregated by campaign, ad group, creative, or asset group unit.
path Parameters
| aggregationType required | string Enum: "campaigns" "adSets" "creatives" "assetGroups" Performance aggregation unit (campaign: campaigns, ad group: adSets, creative: creatives, asset group: assetGroups) |
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| timeUnit | string Default: "daily" Value: "daily" Interval for retrieving data (By day: daily) |
| startDate required | string <date> Example: startDate=2023-01-01 Start date (yyyy-MM-dd) |
| endDate required | string <date> Example: endDate=2023-01-30 End date (yyyy-MM-dd) |
| next | string Example: next=zwMvjK6XRhyiJoFGZZkqhw:1707978058060 Next page token |
| limit | int Default: "1000" Number of records to get |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account number that has access to the performance data of the ad account |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "convType": "string"
}
], - "next": "string"
}Get past conversion data of a creative
Gets past conversion performance data for a specific creative.
path Parameters
| creativeNo required | integer <int64> Example: 5678 Creative number |
| aggregationType required | string Value: "creatives" Performance data aggregation type (creatives: by creative) |
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| timeUnit | string Default: "daily" Value: "daily" Interval for retrieving data (By day: daily) |
| startDate required | string <date> Example: startDate=2023-01-01 Start date (yyyy-MM-dd) |
| endDate required | string <date> Example: endDate=2023-01-30 End date (yyyy-MM-dd) |
| next | string Example: next=zwMvjK6XRhyiJoFGZZkqhw:1707978058060 Next page token |
| limit | int Default: "1000" Number of records to get |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account number that has access to the performance data of the ad account |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "convType": "string"
}
], - "next": "string"
}Get past conversion data of a campaign
Retrieves the past conversion performance of a specific campaign, aggregated by ad group, creative, or asset group unit.
path Parameters
| campaignNo required | integer <int64> Example: 5678 Campaign number |
| aggregationType required | string Enum: "adSets" "creatives" "assetGroups" Performance aggregation unit (ad group: adSets, creative: creatives, asset group: assetGroups) |
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| timeUnit | string Default: "daily" Value: "daily" Interval for retrieving data (By day: daily) |
| startDate required | string <date> Example: startDate=2023-01-01 Start date (yyyy-MM-dd) |
| endDate required | string <date> Example: endDate=2023-01-30 End date (yyyy-MM-dd) |
| next | string Example: next=zwMvjK6XRhyiJoFGZZkqhw:1707978058060 Next page token |
| limit | int Default: "1000" Number of records to get |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account number that has access to the performance data of the ad account |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "convType": "string"
}
], - "next": "string"
}Get past conversion data of an ad group
Gets past conversion performance data for a specific ad group at the creative level.
path Parameters
| adSetNo required | integer <int64> Example: 5678 Ad group number |
| aggregationType required | string Value: "creatives" Performance data aggregation type (creatives: by creative) |
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| timeUnit | string Default: "daily" Value: "daily" Interval for retrieving data (By day: daily) |
| startDate required | string <date> Example: startDate=2023-01-01 Start date (yyyy-MM-dd) |
| endDate required | string <date> Example: endDate=2023-01-30 End date (yyyy-MM-dd) |
| next | string Example: next=zwMvjK6XRhyiJoFGZZkqhw:1707978058060 Next page token |
| limit | int Default: "1000" Number of records to get |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account number that has access to the performance data of the ad account |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "convType": "string"
}
], - "next": "string"
}Retrieve Asset Group Past Conversion Performance
Retrieves the past conversion performance of a specific asset group.
path Parameters
| assetGroupNo required | integer <int64> Example: 5678 Asset group number |
| aggregationType required | string Value: "assetGroups" Performance aggregation unit (asset group: assetGroups) |
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| timeUnit | string Default: "daily" Value: "daily" Lookup time unit (daily: daily) |
| startDate required | string <date> Example: startDate=2023-01-01 Lookup start date (yyyy-MM-dd format) |
| endDate required | string <date> Example: endDate=2023-01-30 Lookup end date (yyyy-MM-dd format) |
| next | string Example: next=zwMvjK6XRhyiJoFGZZkqhw:1707978058060 Token for retrieving the next page |
| limit | int Default: "1000" Number of records to retrieve |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "convType": "string"
}
], - "next": "string"
}Real-time conversion performance is retrieved using the following two lookup hierarchies.
- Creative hierarchy: ad account → campaign → ad group → creative
- Asset group hierarchy: ad account → campaign → asset group
Today's or yesterday's data can be retrieved, and performance is provided sorted in ascending order based on the update time.
Including the response's until field value as the since parameter in the next request retrieves only performance updated after the previous response's until.
Even after the lookup time, real-time performance may change due to consistency verification and correction work.
Conversion performance does not support hourly lookup and is only available on a daily basis. For a description of the response's convType field, please refer to the 'Getting Started > Performance Management > Conversion Performance Lookup' page.
Get real-time conversion data of an ad account
Retrieves the real-time conversion performance of a specific ad account by creative unit.
path Parameters
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| timeUnit | string Default: "daily" Value: "daily" Interval for retrieving data (By day: daily) |
| targetDate | string Default: "today" Enum: "today" "yesterday" Date (today or yesterday) |
| since | integer <int64> Example: since=1675907423000 Millisecond-unit timestamp for retrieving only performance updated after a specific point in time |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account number that has access to the performance data of the ad account |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "convType": "string"
}
], - "until": 1675907423000
}Get real-time conversion data of a creative
Gets real-time conversion performance data for a specific creative.
path Parameters
| creativeNo required | integer <int64> Example: 5678 Creative number |
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| timeUnit | string Default: "daily" Value: "daily" Interval for retrieving data (By day: daily) |
| targetDate | string Default: "today" Enum: "today" "yesterday" Date (today or yesterday) |
| since | integer <int64> Example: since=1675907423000 Millisecond-unit timestamp for retrieving only performance updated after a specific point in time |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account number that has access to the performance data of the ad account |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "convType": "string"
}
], - "until": 1675907423000
}Get real-time conversion data of a campaign
Retrieves the real-time conversion performance of a specific campaign by creative unit.
path Parameters
| campaignNo required | integer <int64> Example: 5678 Campaign number |
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| timeUnit | string Default: "daily" Value: "daily" Interval for retrieving data (By day: daily) |
| targetDate | string Default: "today" Enum: "today" "yesterday" Date (today or yesterday) |
| since | integer <int64> Example: since=1675907423000 Millisecond-unit timestamp for retrieving only performance updated after a specific point in time |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account number that has access to the performance data of the ad account |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "convType": "string"
}
], - "until": 1675907423000
}Get real-time conversion data of an ad group
Retrieves the real-time conversion performance of a specific ad group by creative unit.
path Parameters
| adSetNo required | integer <int64> Example: 5678 Ad group number |
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| timeUnit | string Default: "daily" Value: "daily" Interval for retrieving data (By day: daily) |
| targetDate | string Default: "today" Enum: "today" "yesterday" Date (today or yesterday) |
| since | integer <int64> Example: since=1675907423000 Millisecond-unit timestamp for retrieving only performance updated after a specific point in time |
header Parameters
| AccessManagerAccountNo | integer <int64> Manager account number that has access to the performance data of the ad account |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "convType": "string"
}
], - "until": 1675907423000
}Retrieve Campaign Real-Time Conversion Performance (Asset Group)
Retrieves the real-time conversion performance of a specific campaign by asset group unit.
path Parameters
| campaignNo required | integer <int64> Example: 5678 Campaign number |
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| timeUnit | string Default: "daily" Value: "daily" Lookup time unit (daily: daily) |
| targetDate | string Default: "today" Enum: "today" "yesterday" Lookup target date (today: today, yesterday: yesterday) |
| since | integer <int64> Example: since=1675907423000 Millisecond-unit timestamp for retrieving only performance updated after a specific point in time |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "convType": "string"
}
], - "until": 1675907423000
}Retrieve Ad Account Real-Time Conversion Performance (Asset Group)
Retrieves the real-time conversion performance of a specific ad account by asset group unit.
path Parameters
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| timeUnit | string Default: "daily" Value: "daily" Lookup time unit (daily: daily) |
| targetDate | string Default: "today" Enum: "today" "yesterday" Lookup target date (today: today, yesterday: yesterday) |
| since | integer <int64> Example: since=1675907423000 Millisecond-unit timestamp for retrieving only performance updated after a specific point in time |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "convType": "string"
}
], - "until": 1675907423000
}Retrieve Asset Group Real-Time Conversion Performance
Retrieves the real-time conversion performance of a specific asset group.
path Parameters
| assetGroupNo required | integer <int64> Example: 5678 Asset group number |
| version required | number Default: 1 API version |
| adAccountNo required | integer <int64> Example: 1234 Ad account number |
query Parameters
| timeUnit | string Default: "daily" Value: "daily" Lookup time unit (daily: daily) |
| targetDate | string Default: "today" Enum: "today" "yesterday" Lookup target date (today: today, yesterday: yesterday) |
| since | integer <int64> Example: since=1675907423000 Millisecond-unit timestamp for retrieving only performance updated after a specific point in time |
Responses
Response samples
- 200
{- "rows": [
- {
- "campaignNo": 0,
- "adSetNo": 0,
- "creativeNo": 0,
- "assetGroupNo": 0,
- "targetDate": "2019-08-24",
- "convCount": 0,
- "convSales": 0.1,
- "updatedAt": "2019-08-24T14:15:22Z",
- "convType": "string"
}
], - "until": 1675907423000
}