본문으로 건너뛰기
API docs by Redocly

Performance API

Download OpenAPI specification:Download

Gets past or real-time performance data by GFA ad account, campaign, ad group, or creative.

Get past data

Gets past performance data for a specific ad account, campaign, ad group, or creative.

It returns performance data aggregated for child elements of the specified ad account, campaign, ad group, or creative, with the results sorted in ascending order based on dates, advertisers, campaigns, ad groups, and creative numbers.

The date range can be up to 31 days, starting from 2 years ago and ending as recently as yesterday. (The data from yesterday can be retrieved starting from 2 AM today.)

The API returns up to 1,000 rows at a time. If there are more rows, the results are paginated. Include the value of the “next” field in the response as the “next” parameter of the next request, then you can get the next page; the token will be valid for 10 minutes.

Get past data of an ad account

Gets past performance data for a specific ad account, aggregated by campaign, ad group, or creative.

path Parameters
aggregationType
required
string
Enum: "campaigns" "adSets" "creatives"

Performance data aggregation type (campaigns: by campaign, adSets: by ad group, creatives: by creative)

version
required
float
Default: "1.0"

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
required
integer <int64>

Manager account number that has access to the performance data of the ad account

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "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
float
Default: "1.0"

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
required
integer <int64>

Manager account number that has access to the performance data of the ad account

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "next": "string"
}

Get past data of a campaign

Gets past performance data for a specific campaign, aggregated by ad group or creative.

path Parameters
campaignNo
required
integer <int64>
Example: 5678

Campaign number

aggregationType
required
string
Enum: "adSets" "creatives"

Performance data aggregation type (adSets: by ad group, creatives: by creative)

version
required
float
Default: "1.0"

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
required
integer <int64>

Manager account number that has access to the performance data of the ad account

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "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
float
Default: "1.0"

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
required
integer <int64>

Manager account number that has access to the performance data of the ad account

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "next": "string"
}

Get real-time data

Gets real-time performance data for a specific ad account, campaign, ad group, or creative, aggregated by creative.

It returns performance data from today or yesterday, with the results sorted in ascending order based on update dates.

Include the value of the “until” field in the response as the “since” parameter of the next request, then you can get only the creatives that have been updated after the previous request.

Note that the real-time performance data may change for further consistency verification and correction after the API request is made.

Get real-time data of an ad account

Gets real-time performance data for a specific ad account.

path Parameters
version
required
float
Default: "1.0"

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=1675907423

Timestamp used to get only the creatives whose performance data has been updated after a specific point of time

timeUnit
string
Default: "daily"
Enum: "daily" "hourly"

Interval for retrieving data (By day: daily, By hour: hourly)

header Parameters
AccessManagerAccountNo
required
integer <int64>

Manager account number that has access to the performance data of the ad account

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "until": 0
}

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
float
Default: "1.0"

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=1675907423

Timestamp used to get only the creatives whose performance data has been updated after a specific point of time

timeUnit
string
Default: "daily"
Enum: "daily" "hourly"

Interval for retrieving data (By day: daily, By hour: hourly)

header Parameters
AccessManagerAccountNo
required
integer <int64>

Manager account number that has access to the performance data of the ad account

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "until": 0
}

Get real-time data of a campaign

Gets real-time performance data for a specific campaign.

path Parameters
campaignNo
required
integer <int64>
Example: 5678

Campaign number

version
required
float
Default: "1.0"

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=1675907423

Timestamp used to get only the creatives whose performance data has been updated after a specific point of time

timeUnit
string
Default: "daily"
Enum: "daily" "hourly"

Interval for retrieving data (By day: daily, By hour: hourly)

header Parameters
AccessManagerAccountNo
required
integer <int64>

Manager account number that has access to the performance data of the ad account

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "until": 0
}

Get real-time data of an ad group

Gets real-time performance data for a specific ad group.

path Parameters
adSetNo
required
integer <int64>
Example: 5678

Ad group number

version
required
float
Default: "1.0"

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=1675907423

Timestamp used to get only the creatives whose performance data has been updated after a specific point of time

timeUnit
string
Default: "daily"
Enum: "daily" "hourly"

Interval for retrieving data (By day: daily, By hour: hourly)

header Parameters
AccessManagerAccountNo
required
integer <int64>

Manager account number that has access to the performance data of the ad account

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "until": 0
}

Get past conversion data

Gets past conversion performance data for a specific ad account, campaign, ad group, or creative.

It returns performance data aggregated for child elements of the specified ad account, campaign, ad group, or creative, with the results sorted in ascending order based on dates, advertisers, campaigns, ad groups, and creative numbers.

The date range can be up to 31 days, starting from 2 years ago and ending as recently as yesterday. (The data from yesterday can be retrieved starting from 2 AM today.)

The API returns up to 1,000 rows at a time. If there are more rows, the results are paginated. Include the value of the “next” field in the response as the “next” parameter of the next request, then you can get the next page; the token will be valid for 10 minutes.

Note that performance data retrieval supports only daily intervals; hourly intervals are not supported. For details about convType response fields, go to Getting Started > Performance > Get conversion data.

Get past conversion data of an ad account

Gets past conversion performance data for a specific ad account at the campaign, ad group, or creative level.

path Parameters
aggregationType
required
string
Enum: "campaigns" "adSets" "creatives"

Performance data aggregation type (campaigns: by campaign, adSets: by ad group, creatives: by creative)

version
required
float
Default: "1.0"

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
required
integer <int64>

Manager account number that has access to the performance data of the ad account

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "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
float
Default: "1.0"

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
required
integer <int64>

Manager account number that has access to the performance data of the ad account

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "next": "string"
}

Get past conversion data of a campaign

Gets past conversion performance data for a specific campaign at the ad group or creative level.

path Parameters
campaignNo
required
integer <int64>
Example: 5678

Campaign number

aggregationType
required
string
Enum: "adSets" "creatives"

Performance data aggregation type (adSets: by ad group, creatives: by creative)

version
required
float
Default: "1.0"

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
required
integer <int64>

Manager account number that has access to the performance data of the ad account

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "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
float
Default: "1.0"

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
required
integer <int64>

Manager account number that has access to the performance data of the ad account

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "next": "string"
}

Get real-time conversion data

Gets real-time conversion performance data for a specific ad account, campaign, ad group, or creative, aggregated by creative.

It returns performance data from today or yesterday, with the results sorted in ascending order based on update dates.

Include the value of the “until” field in the response as the “since” parameter of the next request, then you can get only the creatives that have been updated after the previous request.

Note that the real-time performance data may change for further consistency verification and correction after the API request is made.

For details about convType response fields, go to Getting Started > Performance > Get conversion data.

Get real-time conversion data of an ad account

Gets real-time conversion performance data for a specific ad account.

path Parameters
version
required
float
Default: "1.0"

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=1675907423

Timestamp used to get only the creatives whose performance data has been updated after a specific point of time

header Parameters
AccessManagerAccountNo
required
integer <int64>

Manager account number that has access to the performance data of the ad account

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "until": 0
}

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
float
Default: "1.0"

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=1675907423

Timestamp used to get only the creatives whose performance data has been updated after a specific point of time

header Parameters
AccessManagerAccountNo
required
integer <int64>

Manager account number that has access to the performance data of the ad account

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "until": 0
}

Get real-time conversion data of a campaign

Gets real-time conversion performance data for a specific campaign.

path Parameters
campaignNo
required
integer <int64>
Example: 5678

Campaign number

version
required
float
Default: "1.0"

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=1675907423

Timestamp used to get only the creatives whose performance data has been updated after a specific point of time

header Parameters
AccessManagerAccountNo
required
integer <int64>

Manager account number that has access to the performance data of the ad account

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "until": 0
}

Get real-time conversion data of an ad group

Gets real-time conversion performance data for a specific ad group.

path Parameters
adSetNo
required
integer <int64>
Example: 5678

Ad group number

version
required
float
Default: "1.0"

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=1675907423

Timestamp used to get only the creatives whose performance data has been updated after a specific point of time

header Parameters
AccessManagerAccountNo
required
integer <int64>

Manager account number that has access to the performance data of the ad account

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "until": 0
}