Coccoc QC API

To get access to QC API, please, contact your personal manager or reach us by any of the following contact data: phone number (024) 38 838 838 or email support_qc@coccoc.com

The QC API provides a representation of the data found in your account at Coccoc QC. We follow the RESTful principles, so the API is stateless and http methods and response codes are used whenever possible.

Interaction with resources

Request

The base url for the requests is: https://api.qc.coccoc.com/v1 POST request data must be JSON encoded and placed directly in the request body.

Authentication

To use the API you must specify access_token GET param in an every request.

Limits

There are limits of requests per hour. We show usage limit in response. Example below means you used 12% of capacity.

“usage_limit”: { “used”: 0.12, “limit”: 1 },

Response

Response status codes

API will respond with one of the following status codes:

Code	Description
200	Success. Request completed
201	Success. New resource created
400	Bad Request. Request could not be parsed
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
422	Unprocessable Entity. Request could not be parsed due to validation errors
429	Rate limit exceeded, try again later
500	Server error

Response body

All API responses will be returned in JSON format in one of following envelope:

Success object response:

{
  "success": true,
  "usage_limit": { 
    "used": 0.12,
    "limit": 1
  },
  "data": {
    "integer": 12345,
    "string": "John",
    "bool": true,
    "null": null,
    "array": [1, 2, 3],
    "object": {
      "one": 1,
      "two": 2,
      "three": 3
    }
  }
}

Success collection response:

{
  "success": true,
  "usage_limit": { 
    "used": 0.12,
    "limit": 1
  },
  "pagination": {
    "total": 12345,
    "limit": 20,
    "offset": 0
  },
  "data": [
    {
      "integer": 12345,
      "string": "John",
      "bool": true,
      "null": null,
      "array": [1, 2, 3],
      "object": {
        "one": 1,
        "two": 2,
        "three": 3
      }
    }
  ]
}

Failed response:

{
    "success": false,
    "error": {
        "code": 42,
        "message": "Error message"
    }
}

Failed response with invalid fields:

{
    "success": false,
    "error": {
        "code": 42,
        "message": "Error message",
        "invalid_fields": [
            {
                "field": "some_name",
                "code": 42,
                "message": "Error message"
            }
        ]
    }
}

Campaigns ¶

Campaign ¶

Get campaign
GET`/campaigns/{id}{?access_token}`

Example URI

GET https://api.qc.coccoc.com/v1/campaigns/1?access_token=5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx

URI Parameters

HideShow

id: number (required) Example: 1
Campaign ID
access_token: string (required) Example: 5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx
API access token

Response 200

HideShow

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "success": true,
  "usage_limit": {
    "used": 0.12,
    "limit": 1
  },
  "data": {
    "id": 1,
    "type": 1,
    "name": "My campaign",
    "status": "active",
    "tracking_enabled": true,
    "spendings_limit": 100000,
    "spendings_daily_limit": 14000,
    "start_date": "2015-01-01",
    "end_date": "2015-01-02"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "usage_limit": {
      "type": "object",
      "properties": {
        "used": {
          "type": "number"
        },
        "limit": {
          "type": "number"
        }
      },
      "required": [
        "used",
        "limit"
      ]
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Campaign ID"
        },
        "type": {
          "type": "number",
          "description": "Campaign type. You can't change it.\n\nAvailable types:\n\n- `1` - Search ad campaign\n\n- `2` - Newtab banner campaign\n\n- `3` - Search banner campaign\n\n- `4` - Icon campaign\n\n- `6` - Shopping ad campaign\n\n- `9` - Skin campaign"
        },
        "name": {
          "type": "string",
          "description": "Campaign name"
        },
        "status": {
          "type": "string",
          "description": "Campaign status:\n\n- `active` - Active campaign\n\n- `stopped` - Stopped campaign\n\n- `archived` - Archived campaign\n\nDefault: `active`"
        },
        "tracking_enabled": {
          "type": "boolean",
          "description": "Enable auto-adding utm marks.\n\nDefault: `true`"
        },
        "spendings_limit": {
          "type": "number",
          "description": "Campaign weekly spendings in VND\n\nDefault: `null`"
        },
        "spendings_daily_limit": {
          "type": "number",
          "description": "Campaign daily spendings in VND\n\nDefault: `null`"
        },
        "start_date": {
          "type": "string",
          "description": "Campaign start date in ISO 8601 format (`YYYY-MM-DD`)\n\nDefault: today"
        },
        "end_date": {
          "type": "string",
          "description": "Campaign end date in ISO 8601 format  (`YYYY-MM-DD`)\n\nDefault: `null`"
        }
      },
      "required": [
        "id",
        "type",
        "name"
      ]
    }
  },
  "required": [
    "success",
    "usage_limit",
    "data"
  ]
}

Update campaign
PUT`/campaigns/{id}{?access_token}`

Example URI

PUT https://api.qc.coccoc.com/v1/campaigns/1?access_token=5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx

URI Parameters

HideShow

id: number (required) Example: 1
Campaign ID
access_token: string (required) Example: 5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx
API access token

Attributes

type

number (required) Example: 1

Campaign type. You can’t change it.

Available types:

1 - Search ad campaign
2 - Newtab banner campaign
3 - Search banner campaign
4 - Icon campaign
6 - Shopping ad campaign
9 - Skin campaign

name

string (required) Example: My campaign

Campaign name

status

string (optional) Example: active

Campaign status:

active - Active campaign
stopped - Stopped campaign
archived - Archived campaign

Default: active

tracking_enabled

boolean (optional) Example: true

Enable auto-adding utm marks.

Default: true

spendings_limit

number (optional) Example: 100000

Campaign weekly spendings in VND

Default: null

spendings_daily_limit

number (optional) Example: 14000

Campaign daily spendings in VND

Default: null

start_date

string (optional) Example: 2015-01-01

Campaign start date in ISO 8601 format (YYYY-MM-DD)

Default: today

end_date

string (optional) Example: 2015-01-02

Campaign end date in ISO 8601 format (YYYY-MM-DD)

Default: null

Request

HideShow

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": 1,
  "name": "My campaign",
  "status": "active",
  "tracking_enabled": true,
  "spendings_limit": 100000,
  "spendings_daily_limit": 14000,
  "start_date": "2015-01-01",
  "end_date": "2015-01-02"
}

Response 200

HideShow

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "success": true,
  "usage_limit": {
    "used": 0.12,
    "limit": 1
  },
  "data": {
    "id": 1,
    "type": 1,
    "name": "My campaign",
    "status": "active",
    "tracking_enabled": true,
    "spendings_limit": 100000,
    "spendings_daily_limit": 14000,
    "start_date": "2015-01-01",
    "end_date": "2015-01-02"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "usage_limit": {
      "type": "object",
      "properties": {
        "used": {
          "type": "number"
        },
        "limit": {
          "type": "number"
        }
      },
      "required": [
        "used",
        "limit"
      ]
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Campaign ID"
        },
        "type": {
          "type": "number",
          "description": "Campaign type. You can't change it.\n\nAvailable types:\n\n- `1` - Search ad campaign\n\n- `2` - Newtab banner campaign\n\n- `3` - Search banner campaign\n\n- `4` - Icon campaign\n\n- `6` - Shopping ad campaign\n\n- `9` - Skin campaign"
        },
        "name": {
          "type": "string",
          "description": "Campaign name"
        },
        "status": {
          "type": "string",
          "description": "Campaign status:\n\n- `active` - Active campaign\n\n- `stopped` - Stopped campaign\n\n- `archived` - Archived campaign\n\nDefault: `active`"
        },
        "tracking_enabled": {
          "type": "boolean",
          "description": "Enable auto-adding utm marks.\n\nDefault: `true`"
        },
        "spendings_limit": {
          "type": "number",
          "description": "Campaign weekly spendings in VND\n\nDefault: `null`"
        },
        "spendings_daily_limit": {
          "type": "number",
          "description": "Campaign daily spendings in VND\n\nDefault: `null`"
        },
        "start_date": {
          "type": "string",
          "description": "Campaign start date in ISO 8601 format (`YYYY-MM-DD`)\n\nDefault: today"
        },
        "end_date": {
          "type": "string",
          "description": "Campaign end date in ISO 8601 format  (`YYYY-MM-DD`)\n\nDefault: `null`"
        }
      },
      "required": [
        "id",
        "type",
        "name"
      ]
    }
  },
  "required": [
    "success",
    "usage_limit",
    "data"
  ]
}

Partial update campaign
PATCH`/campaigns/{id}{?access_token}`

Example URI

PATCH https://api.qc.coccoc.com/v1/campaigns/1?access_token=5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx

URI Parameters

HideShow

id: number (required) Example: 1
Campaign ID
access_token: string (required) Example: 5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx
API access token

Attributes

type

number (optional) Example: 1

Campaign type. You can’t change it.

Available types:

1 - Search ad campaign
2 - Newtab banner campaign
3 - Search banner campaign
4 - Icon campaign
6 - Shopping ad campaign
9 - Skin campaign

name

string (optional) Example: My campaign

Campaign name

status

string (optional) Example: active

Campaign status:

active - Active campaign
stopped - Stopped campaign
archived - Archived campaign

Default: active

tracking_enabled

boolean (optional) Example: true

Enable auto-adding utm marks.

Default: true

spendings_limit

number (optional) Example: 100000

Campaign weekly spendings in VND

Default: null

spendings_daily_limit

number (optional) Example: 14000

Campaign daily spendings in VND

Default: null

start_date

string (optional) Example: 2015-01-01

Campaign start date in ISO 8601 format (YYYY-MM-DD)

Default: today

end_date

string (optional) Example: 2015-01-02

Campaign end date in ISO 8601 format (YYYY-MM-DD)

Default: null

Request

HideShow

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": 1,
  "name": "My campaign",
  "status": "active",
  "tracking_enabled": true,
  "spendings_limit": 100000,
  "spendings_daily_limit": 14000,
  "start_date": "2015-01-01",
  "end_date": "2015-01-02"
}

Response 200

HideShow

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "success": true,
  "usage_limit": {
    "used": 0.12,
    "limit": 1
  },
  "data": {
    "id": 1,
    "type": 1,
    "name": "My campaign",
    "status": "active",
    "tracking_enabled": true,
    "spendings_limit": 100000,
    "spendings_daily_limit": 14000,
    "start_date": "2015-01-01",
    "end_date": "2015-01-02"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "usage_limit": {
      "type": "object",
      "properties": {
        "used": {
          "type": "number"
        },
        "limit": {
          "type": "number"
        }
      },
      "required": [
        "used",
        "limit"
      ]
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Campaign ID"
        },
        "type": {
          "type": "number",
          "description": "Campaign type. You can't change it.\n\nAvailable types:\n\n- `1` - Search ad campaign\n\n- `2` - Newtab banner campaign\n\n- `3` - Search banner campaign\n\n- `4` - Icon campaign\n\n- `6` - Shopping ad campaign\n\n- `9` - Skin campaign"
        },
        "name": {
          "type": "string",
          "description": "Campaign name"
        },
        "status": {
          "type": "string",
          "description": "Campaign status:\n\n- `active` - Active campaign\n\n- `stopped` - Stopped campaign\n\n- `archived` - Archived campaign\n\nDefault: `active`"
        },
        "tracking_enabled": {
          "type": "boolean",
          "description": "Enable auto-adding utm marks.\n\nDefault: `true`"
        },
        "spendings_limit": {
          "type": "number",
          "description": "Campaign weekly spendings in VND\n\nDefault: `null`"
        },
        "spendings_daily_limit": {
          "type": "number",
          "description": "Campaign daily spendings in VND\n\nDefault: `null`"
        },
        "start_date": {
          "type": "string",
          "description": "Campaign start date in ISO 8601 format (`YYYY-MM-DD`)\n\nDefault: today"
        },
        "end_date": {
          "type": "string",
          "description": "Campaign end date in ISO 8601 format  (`YYYY-MM-DD`)\n\nDefault: `null`"
        }
      },
      "required": [
        "id",
        "type",
        "name"
      ]
    }
  },
  "required": [
    "success",
    "usage_limit",
    "data"
  ]
}

Campaigns ¶

Get campaigns list
GET`/campaigns{?limit,offset}`

Example URI

GET https://api.qc.coccoc.com/v1/campaigns?limit=&offset=

URI Parameters

HideShow

limit: number (optional) Default: 50
A limit on the number of objects to be returned. Limit can range between 1 and 50 items.
offset: number (optional) Default: 0
Returned objects offset.

Response 200

HideShow

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "success": true,
  "usage_limit": {
    "used": 0.12,
    "limit": 1
  },
  "pagination": {
    "total": 12345,
    "limit": 50,
    "offset": 0
  },
  "data": [
    null
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "usage_limit": {
      "type": "object",
      "properties": {
        "used": {
          "type": "number"
        },
        "limit": {
          "type": "number"
        }
      },
      "required": [
        "used",
        "limit"
      ]
    },
    "pagination": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number"
        },
        "limit": {
          "type": "number"
        },
        "offset": {
          "type": "number"
        }
      },
      "required": [
        "total",
        "limit",
        "offset"
      ]
    },
    "data": {
      "type": "array"
    }
  },
  "required": [
    "success",
    "usage_limit",
    "pagination",
    "data"
  ]
}

Create campaign
POST`/campaigns{?access_token}`

Example URI

POST https://api.qc.coccoc.com/v1/campaigns?access_token=5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx

URI Parameters

HideShow

access_token: string (required) Example: 5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx
API access token

Attributes

type

number (required) Example: 1

Campaign type. You can’t change it.

Available types:

1 - Search ad campaign
2 - Newtab banner campaign
3 - Search banner campaign
4 - Icon campaign
6 - Shopping ad campaign
9 - Skin campaign

name

string (required) Example: My campaign

Campaign name

status

string (optional) Example: active

Campaign status:

active - Active campaign
stopped - Stopped campaign
archived - Archived campaign

Default: active

tracking_enabled

boolean (optional) Example: true

Enable auto-adding utm marks.

Default: true

spendings_limit

number (optional) Example: 100000

Campaign weekly spendings in VND

Default: null

spendings_daily_limit

number (optional) Example: 14000

Campaign daily spendings in VND

Default: null

start_date

string (optional) Example: 2015-01-01

Campaign start date in ISO 8601 format (YYYY-MM-DD)

Default: today

end_date

string (optional) Example: 2015-01-02

Campaign end date in ISO 8601 format (YYYY-MM-DD)

Default: null

Request

HideShow

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": 1,
  "name": "My campaign",
  "status": "active",
  "tracking_enabled": true,
  "spendings_limit": 100000,
  "spendings_daily_limit": 14000,
  "start_date": "2015-01-01",
  "end_date": "2015-01-02"
}

Response 201

HideShow

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "success": true,
  "usage_limit": {
    "used": 0.12,
    "limit": 1
  },
  "data": {
    "id": 1,
    "type": 1,
    "name": "My campaign",
    "status": "active",
    "tracking_enabled": true,
    "spendings_limit": 100000,
    "spendings_daily_limit": 14000,
    "start_date": "2015-01-01",
    "end_date": "2015-01-02"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "usage_limit": {
      "type": "object",
      "properties": {
        "used": {
          "type": "number"
        },
        "limit": {
          "type": "number"
        }
      },
      "required": [
        "used",
        "limit"
      ]
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Campaign ID"
        },
        "type": {
          "type": "number",
          "description": "Campaign type. You can't change it.\n\nAvailable types:\n\n- `1` - Search ad campaign\n\n- `2` - Newtab banner campaign\n\n- `3` - Search banner campaign\n\n- `4` - Icon campaign\n\n- `6` - Shopping ad campaign\n\n- `9` - Skin campaign"
        },
        "name": {
          "type": "string",
          "description": "Campaign name"
        },
        "status": {
          "type": "string",
          "description": "Campaign status:\n\n- `active` - Active campaign\n\n- `stopped` - Stopped campaign\n\n- `archived` - Archived campaign\n\nDefault: `active`"
        },
        "tracking_enabled": {
          "type": "boolean",
          "description": "Enable auto-adding utm marks.\n\nDefault: `true`"
        },
        "spendings_limit": {
          "type": "number",
          "description": "Campaign weekly spendings in VND\n\nDefault: `null`"
        },
        "spendings_daily_limit": {
          "type": "number",
          "description": "Campaign daily spendings in VND\n\nDefault: `null`"
        },
        "start_date": {
          "type": "string",
          "description": "Campaign start date in ISO 8601 format (`YYYY-MM-DD`)\n\nDefault: today"
        },
        "end_date": {
          "type": "string",
          "description": "Campaign end date in ISO 8601 format  (`YYYY-MM-DD`)\n\nDefault: `null`"
        }
      },
      "required": [
        "id",
        "type",
        "name"
      ]
    }
  },
  "required": [
    "success",
    "usage_limit",
    "data"
  ]
}

Campaign Stats ¶

Get campaign stats (Deprecated)
GET`/campaigns/{id}/stats{?access_token,start_date,end_date}`

DEPRECATED

This api is no longer available

Example URI

GET https://api.qc.coccoc.com/v1/campaigns/1/stats?access_token=5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx&start_date=2015-01-01&end_date=2015-01-01

URI Parameters

HideShow

id: number (required) Example: 1
Campaign ID
start_date: string (required) Example: 2015-01-01
Start of period date in ISO 8601 format (YYYY-MM-DD)
end_date: string (required) Example: 2015-01-01
End of period date in ISO 8601 format (YYYY-MM-DD)
access_token: string (required) Example: 5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx
API access token

Response 200

HideShow

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "success": true,
  "usage_limit": {
    "used": 0.12,
    "limit": 1
  },
  "pagination": {
    "total": 12345,
    "limit": 50,
    "offset": 0
  },
  "data": [
    {
      "date": "2015-01-01",
      "adverts": [
        null
      ]
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "usage_limit": {
      "type": "object",
      "properties": {
        "used": {
          "type": "number"
        },
        "limit": {
          "type": "number"
        }
      },
      "required": [
        "used",
        "limit"
      ]
    },
    "pagination": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number"
        },
        "limit": {
          "type": "number"
        },
        "offset": {
          "type": "number"
        }
      },
      "required": [
        "total",
        "limit",
        "offset"
      ]
    },
    "data": {
      "type": "array"
    }
  },
  "required": [
    "success",
    "usage_limit",
    "pagination",
    "data"
  ]
}

Adverts ¶

Advert ¶

Get advert
GET`/adverts/{id}{?access_token}`

Example URI

GET https://api.qc.coccoc.com/v1/adverts/1?access_token=5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx

URI Parameters

HideShow

id: number (required) Example: 1
Advert ID
access_token: string (required) Example: 5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx
API access token

Response 200

HideShow

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "success": true,
  "usage_limit": {
    "used": 0.12,
    "limit": 1
  },
  "data": {
    "id": 12345,
    "campaign_id": 1,
    "name": "Advert name",
    "title": "New Advert",
    "description": "New advert promo text",
    "url": "http://example.com",
    "enabled": true,
    "placements": [
      "newtab",
      "serp"
    ],
    "address": "Number 5, alley 19/535, Kim Ma St., Hanoi",
    "matches": [
      {
        "id": 12345,
        "phrase": "one",
        "bid": 1000,
        "enabled": true
      }
    ],
    "moderation_status": "",
    "image": {
      "url": "http://cdn.qc.coccoc.com/2015-06-16/b9/c7/606003bd1c4384cfcbd4144b87ed.png",
      "width": 90,
      "height": 90
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "usage_limit": {
      "type": "object",
      "properties": {
        "used": {
          "type": "number"
        },
        "limit": {
          "type": "number"
        }
      },
      "required": [
        "used",
        "limit"
      ]
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Advert's ID"
        },
        "campaign_id": {
          "type": "number",
          "description": "Advert's campaign ID"
        },
        "name": {
          "type": "string",
          "description": "Advert's name"
        },
        "title": {
          "type": "string",
          "description": "Advert's title"
        },
        "description": {
          "type": "string",
          "description": "Advert's description"
        },
        "url": {
          "type": "string",
          "description": "Advert's URL"
        },
        "enabled": {
          "type": "boolean",
          "description": "Is advert enabled\n\nDefault: `true`"
        },
        "placements": {
          "type": "array",
          "description": "Advert placements\n\nAvailable values:\n\n- `newtab` - Coccoc browser's new tab\n\n- `serp` - Coccoc's search results"
        },
        "address": {
          "type": "string",
          "description": "Advert address\n\nDefault: `null`"
        },
        "matches": {
          "type": "array",
          "description": "Advert's matches, which contains phrases or/and interests"
        },
        "moderation_status": {
          "type": "string",
          "description": "Advert moderation status:\n\n- `pending` - An advert on moderation\n\n- `draft` - A draft of an advert\n\n- `approved` - An advert is approved\n\n- `rejected` - An advert is rejected\n\nDefault: `active`"
        },
        "image": {
          "type": "object",
          "properties": {
            "url": {
              "type": "string",
              "description": "Image url"
            },
            "width": {
              "type": "number",
              "description": "Image width in pixels"
            },
            "height": {
              "type": "number",
              "description": "Image height in pixels"
            }
          },
          "required": [
            "url",
            "width",
            "height"
          ],
          "description": "Advert's image"
        }
      },
      "required": [
        "id",
        "campaign_id",
        "name",
        "title",
        "description",
        "url",
        "enabled",
        "placements",
        "matches",
        "moderation_status"
      ]
    }
  },
  "required": [
    "success",
    "usage_limit",
    "data"
  ]
}

Update advert
PUT`/adverts/{id}{?access_token}`

Example URI

PUT https://api.qc.coccoc.com/v1/adverts/1?access_token=5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx

URI Parameters

HideShow

id: number (required) Example: 1
Advert ID
access_token: string (required) Example: 5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx
API access token

Attributes

campaign_id

number (required) Example: 1

Advert’s campaign ID

name

string (required) Example: Advert name

Advert’s name

title

string (required) Example: New Advert

Advert’s title

description

string (required) Example: New advert promo text

Advert’s description

url

string (required) Example: http://example.com

Advert’s URL

enabled

boolean (required) Example: true

Is advert enabled

Default: true

placements

array (required) Example: [ 'newtab', 'serp' ]

Advert placements

Available values:

newtab - Coccoc browser’s new tab
serp - Coccoc’s search results

address

string (optional) Example: Number 5, alley 19/535, Kim Ma St., Hanoi

Advert address

Default: null

matches

array (required)

category

number (optional)

Interest ID or Demographic ID

List of available interests
List of available demographics

phrase: string (optional) Example: one
Search phrase

bid: number (required) Example: 1000
Bid for match (maximum bet)

enabled: boolean (optional) Example: true
Status for match

Advert’s matches, which contains phrases or/and interests

image

string (optional)

Base64-encoded image data

Request

HideShow

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "campaign_id": 1,
  "name": "Advert name",
  "title": "New Advert",
  "description": "New advert promo text",
  "url": "http://example.com",
  "enabled": true,
  "placements": [
    "newtab",
    "serp"
  ],
  "address": "Number 5, alley 19/535, Kim Ma St., Hanoi",
  "matches": [
    {
      "phrase": "one",
      "bid": 1000,
      "enabled": true
    }
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "success": true,
  "usage_limit": {
    "used": 0.12,
    "limit": 1
  },
  "data": {
    "id": 12345,
    "campaign_id": 1,
    "name": "Advert name",
    "title": "New Advert",
    "description": "New advert promo text",
    "url": "http://example.com",
    "enabled": true,
    "placements": [
      "newtab",
      "serp"
    ],
    "address": "Number 5, alley 19/535, Kim Ma St., Hanoi",
    "matches": [
      {
        "id": 12345,
        "phrase": "one",
        "bid": 1000,
        "enabled": true
      }
    ],
    "moderation_status": "",
    "image": {
      "url": "http://cdn.qc.coccoc.com/2015-06-16/b9/c7/606003bd1c4384cfcbd4144b87ed.png",
      "width": 90,
      "height": 90
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "usage_limit": {
      "type": "object",
      "properties": {
        "used": {
          "type": "number"
        },
        "limit": {
          "type": "number"
        }
      },
      "required": [
        "used",
        "limit"
      ]
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Advert's ID"
        },
        "campaign_id": {
          "type": "number",
          "description": "Advert's campaign ID"
        },
        "name": {
          "type": "string",
          "description": "Advert's name"
        },
        "title": {
          "type": "string",
          "description": "Advert's title"
        },
        "description": {
          "type": "string",
          "description": "Advert's description"
        },
        "url": {
          "type": "string",
          "description": "Advert's URL"
        },
        "enabled": {
          "type": "boolean",
          "description": "Is advert enabled\n\nDefault: `true`"
        },
        "placements": {
          "type": "array",
          "description": "Advert placements\n\nAvailable values:\n\n- `newtab` - Coccoc browser's new tab\n\n- `serp` - Coccoc's search results"
        },
        "address": {
          "type": "string",
          "description": "Advert address\n\nDefault: `null`"
        },
        "matches": {
          "type": "array",
          "description": "Advert's matches, which contains phrases or/and interests"
        },
        "moderation_status": {
          "type": "string",
          "description": "Advert moderation status:\n\n- `pending` - An advert on moderation\n\n- `draft` - A draft of an advert\n\n- `approved` - An advert is approved\n\n- `rejected` - An advert is rejected\n\nDefault: `active`"
        },
        "image": {
          "type": "object",
          "properties": {
            "url": {
              "type": "string",
              "description": "Image url"
            },
            "width": {
              "type": "number",
              "description": "Image width in pixels"
            },
            "height": {
              "type": "number",
              "description": "Image height in pixels"
            }
          },
          "required": [
            "url",
            "width",
            "height"
          ],
          "description": "Advert's image"
        }
      },
      "required": [
        "id",
        "campaign_id",
        "name",
        "title",
        "description",
        "url",
        "enabled",
        "placements",
        "matches",
        "moderation_status"
      ]
    }
  },
  "required": [
    "success",
    "usage_limit",
    "data"
  ]
}

Partial update advert
PATCH`/adverts/{id}{?access_token}`

Example URI

PATCH https://api.qc.coccoc.com/v1/adverts/1?access_token=5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx

URI Parameters

HideShow

id: number (required) Example: 1
Advert ID
access_token: string (required) Example: 5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx
API access token

Attributes

campaign_id

number (optional) Example: 1

Advert’s campaign ID

name

string (optional) Example: Advert name

Advert’s name

title

string (optional) Example: New Advert

Advert’s title

description

string (optional) Example: New advert promo text

Advert’s description

url

string (optional) Example: http://example.com

Advert’s URL

enabled

boolean (optional) Example: true

Is advert enabled

Default: true

placements

array (optional) Example: [ 'newtab', 'serp' ]

Advert placements

Available values:

newtab - Coccoc browser’s new tab
serp - Coccoc’s search results

address

string (optional) Example: Number 5, alley 19/535, Kim Ma St., Hanoi

Advert address

Default: null

matches

array (optional)

category

number (optional)

Interest ID or Demographic ID

List of available interests
List of available demographics

phrase: string (optional) Example: one
Search phrase

bid: number (required) Example: 1000
Bid for match (maximum bet)

enabled: boolean (optional) Example: true
Status for match

Advert’s matches, which contains phrases or/and interests

image

string (optional)

Base64-encoded image data

Request

HideShow

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "campaign_id": 1,
  "name": "Advert name",
  "title": "New Advert",
  "description": "New advert promo text",
  "url": "http://example.com",
  "enabled": true,
  "placements": [
    "newtab",
    "serp"
  ],
  "address": "Number 5, alley 19/535, Kim Ma St., Hanoi",
  "matches": [
    {
      "phrase": "one",
      "bid": 1000,
      "enabled": true
    }
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "success": true,
  "usage_limit": {
    "used": 0.12,
    "limit": 1
  },
  "data": {
    "id": 12345,
    "campaign_id": 1,
    "name": "Advert name",
    "title": "New Advert",
    "description": "New advert promo text",
    "url": "http://example.com",
    "enabled": true,
    "placements": [
      "newtab",
      "serp"
    ],
    "address": "Number 5, alley 19/535, Kim Ma St., Hanoi",
    "matches": [
      {
        "id": 12345,
        "phrase": "one",
        "bid": 1000,
        "enabled": true
      }
    ],
    "moderation_status": "",
    "image": {
      "url": "http://cdn.qc.coccoc.com/2015-06-16/b9/c7/606003bd1c4384cfcbd4144b87ed.png",
      "width": 90,
      "height": 90
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "usage_limit": {
      "type": "object",
      "properties": {
        "used": {
          "type": "number"
        },
        "limit": {
          "type": "number"
        }
      },
      "required": [
        "used",
        "limit"
      ]
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Advert's ID"
        },
        "campaign_id": {
          "type": "number",
          "description": "Advert's campaign ID"
        },
        "name": {
          "type": "string",
          "description": "Advert's name"
        },
        "title": {
          "type": "string",
          "description": "Advert's title"
        },
        "description": {
          "type": "string",
          "description": "Advert's description"
        },
        "url": {
          "type": "string",
          "description": "Advert's URL"
        },
        "enabled": {
          "type": "boolean",
          "description": "Is advert enabled\n\nDefault: `true`"
        },
        "placements": {
          "type": "array",
          "description": "Advert placements\n\nAvailable values:\n\n- `newtab` - Coccoc browser's new tab\n\n- `serp` - Coccoc's search results"
        },
        "address": {
          "type": "string",
          "description": "Advert address\n\nDefault: `null`"
        },
        "matches": {
          "type": "array",
          "description": "Advert's matches, which contains phrases or/and interests"
        },
        "moderation_status": {
          "type": "string",
          "description": "Advert moderation status:\n\n- `pending` - An advert on moderation\n\n- `draft` - A draft of an advert\n\n- `approved` - An advert is approved\n\n- `rejected` - An advert is rejected\n\nDefault: `active`"
        },
        "image": {
          "type": "object",
          "properties": {
            "url": {
              "type": "string",
              "description": "Image url"
            },
            "width": {
              "type": "number",
              "description": "Image width in pixels"
            },
            "height": {
              "type": "number",
              "description": "Image height in pixels"
            }
          },
          "required": [
            "url",
            "width",
            "height"
          ],
          "description": "Advert's image"
        }
      },
      "required": [
        "id",
        "campaign_id",
        "name",
        "title",
        "description",
        "url",
        "enabled",
        "placements",
        "matches",
        "moderation_status"
      ]
    }
  },
  "required": [
    "success",
    "usage_limit",
    "data"
  ]
}

Adverts ¶

Description

Get adverts list
GET`/adverts{?campaign_id,limit,offset}`

Description

Example URI

GET https://api.qc.coccoc.com/v1/adverts?campaign_id=1&limit=&offset=

URI Parameters

HideShow

campaign_id: number (required) Example: 1
Campaign ID
limit: number (optional) Default: 50
A limit on the number of objects to be returned. Limit can range between 1 and 50 items.
offset: number (optional) Default: 0
Returned objects offset.

Response 200

HideShow

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "success": true,
  "usage_limit": {
    "used": 0.12,
    "limit": 1
  },
  "pagination": {
    "total": 12345,
    "limit": 50,
    "offset": 0
  },
  "data": [
    null
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "usage_limit": {
      "type": "object",
      "properties": {
        "used": {
          "type": "number"
        },
        "limit": {
          "type": "number"
        }
      },
      "required": [
        "used",
        "limit"
      ]
    },
    "pagination": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number"
        },
        "limit": {
          "type": "number"
        },
        "offset": {
          "type": "number"
        }
      },
      "required": [
        "total",
        "limit",
        "offset"
      ]
    },
    "data": {
      "type": "array"
    }
  },
  "required": [
    "success",
    "usage_limit",
    "pagination",
    "data"
  ]
}

Create advert
POST`/adverts{?access_token}`

Description

Example URI

POST https://api.qc.coccoc.com/v1/adverts?access_token=5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx

URI Parameters

HideShow

access_token: string (required) Example: 5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx
API access token

Attributes

campaign_id

number (required) Example: 1

Advert’s campaign ID

name

string (required) Example: Advert name

Advert’s name

title

string (required) Example: New Advert

Advert’s title

description

string (required) Example: New advert promo text

Advert’s description

url

string (required) Example: http://example.com

Advert’s URL

enabled

boolean (required) Example: true

Is advert enabled

Default: true

placements

array (required) Example: [ 'newtab', 'serp' ]

Advert placements

Available values:

newtab - Coccoc browser’s new tab
serp - Coccoc’s search results

address

string (optional) Example: Number 5, alley 19/535, Kim Ma St., Hanoi

Advert address

Default: null

matches

array (required)

category

number (optional)

Interest ID or Demographic ID

List of available interests
List of available demographics

phrase: string (optional) Example: one
Search phrase

bid: number (required) Example: 1000
Bid for match (maximum bet)

enabled: boolean (optional) Example: true
Status for match

Advert’s matches, which contains phrases or/and interests

image

string (optional)

Base64-encoded image data

Request

HideShow

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "campaign_id": 1,
  "name": "Advert name",
  "title": "New Advert",
  "description": "New advert promo text",
  "url": "http://example.com",
  "enabled": true,
  "placements": [
    "newtab",
    "serp"
  ],
  "address": "Number 5, alley 19/535, Kim Ma St., Hanoi",
  "matches": [
    {
      "phrase": "one",
      "bid": 1000,
      "enabled": true
    }
  ]
}

Response 201

HideShow

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "success": true,
  "usage_limit": {
    "used": 0.12,
    "limit": 1
  },
  "data": {
    "id": 12345,
    "campaign_id": 1,
    "name": "Advert name",
    "title": "New Advert",
    "description": "New advert promo text",
    "url": "http://example.com",
    "enabled": true,
    "placements": [
      "newtab",
      "serp"
    ],
    "address": "Number 5, alley 19/535, Kim Ma St., Hanoi",
    "matches": [
      {
        "id": 12345,
        "phrase": "one",
        "bid": 1000,
        "enabled": true
      }
    ],
    "moderation_status": "",
    "image": {
      "url": "http://cdn.qc.coccoc.com/2015-06-16/b9/c7/606003bd1c4384cfcbd4144b87ed.png",
      "width": 90,
      "height": 90
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "usage_limit": {
      "type": "object",
      "properties": {
        "used": {
          "type": "number"
        },
        "limit": {
          "type": "number"
        }
      },
      "required": [
        "used",
        "limit"
      ]
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Advert's ID"
        },
        "campaign_id": {
          "type": "number",
          "description": "Advert's campaign ID"
        },
        "name": {
          "type": "string",
          "description": "Advert's name"
        },
        "title": {
          "type": "string",
          "description": "Advert's title"
        },
        "description": {
          "type": "string",
          "description": "Advert's description"
        },
        "url": {
          "type": "string",
          "description": "Advert's URL"
        },
        "enabled": {
          "type": "boolean",
          "description": "Is advert enabled\n\nDefault: `true`"
        },
        "placements": {
          "type": "array",
          "description": "Advert placements\n\nAvailable values:\n\n- `newtab` - Coccoc browser's new tab\n\n- `serp` - Coccoc's search results"
        },
        "address": {
          "type": "string",
          "description": "Advert address\n\nDefault: `null`"
        },
        "matches": {
          "type": "array",
          "description": "Advert's matches, which contains phrases or/and interests"
        },
        "moderation_status": {
          "type": "string",
          "description": "Advert moderation status:\n\n- `pending` - An advert on moderation\n\n- `draft` - A draft of an advert\n\n- `approved` - An advert is approved\n\n- `rejected` - An advert is rejected\n\nDefault: `active`"
        },
        "image": {
          "type": "object",
          "properties": {
            "url": {
              "type": "string",
              "description": "Image url"
            },
            "width": {
              "type": "number",
              "description": "Image width in pixels"
            },
            "height": {
              "type": "number",
              "description": "Image height in pixels"
            }
          },
          "required": [
            "url",
            "width",
            "height"
          ],
          "description": "Advert's image"
        }
      },
      "required": [
        "id",
        "campaign_id",
        "name",
        "title",
        "description",
        "url",
        "enabled",
        "placements",
        "matches",
        "moderation_status"
      ]
    }
  },
  "required": [
    "success",
    "usage_limit",
    "data"
  ]
}

Statistics ¶

Get stats for multi Campaigns ¶

Multi Campaigns
GET`/campaigns/statistics{?access_token,start_date,end_date}`

Description

Example URI

GET https://api.qc.coccoc.com/v1/campaigns/statistics?access_token=5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx&start_date=2017-05-30&end_date=2017-05-31

URI Parameters

HideShow

id[]

array (required) Example: id[]=123

Campaigns IDs

For multi campaigns: id[]=123&id[]=456

start_date

string (required) Example: 2017-05-30

Start of period date in ISO 8601 format (YYYY-MM-DD)

end_date

string (required) Example: 2017-05-31

End of period date in ISO 8601 format (YYYY-MM-DD)

access_token

string (required) Example: 5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx

API access token

Response 200

HideShow

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "success": true,
  "usage_limit": {
    "used": 0.12,
    "limit": 1
  },
  "pagination": {
    "total": 12345,
    "limit": 50,
    "offset": 0
  },
  "data": [
    {
      "campaignId": 123,
      "statsTotal": {
        "clicks": 600,
        "impressions": 4000,
        "spendings": 300000
      },
      "statsDetail": [
        {
          "date": "2017-05-30",
          "clicks": 100,
          "impressions": 1000,
          "spendings": 100000
        },
        {
          "date": "2017-05-31",
          "clicks": 500,
          "impressions": 3000,
          "spendings": 200000
        }
      ]
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "usage_limit": {
      "type": "object",
      "properties": {
        "used": {
          "type": "number"
        },
        "limit": {
          "type": "number"
        }
      },
      "required": [
        "used",
        "limit"
      ]
    },
    "pagination": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number"
        },
        "limit": {
          "type": "number"
        },
        "offset": {
          "type": "number"
        }
      },
      "required": [
        "total",
        "limit",
        "offset"
      ]
    },
    "data": {
      "type": "array"
    }
  },
  "required": [
    "success",
    "usage_limit",
    "pagination",
    "data"
  ]
}

Get stats for multi Adverts ¶

Multi Adverts
GET`/adverts/statistics{?access_token,start_date,end_date}`

Example URI

GET https://api.qc.coccoc.com/v1/adverts/statistics?access_token=5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx&start_date=2017-05-30&end_date=2017-05-31

URI Parameters

HideShow

id[]

array (required) Example: id[]=123

Adverts IDs

For multi adverts: id[]=123&id[]=456

start_date

string (required) Example: 2017-05-30

Start of period date in ISO 8601 format (YYYY-MM-DD)

end_date

string (required) Example: 2017-05-31

End of period date in ISO 8601 format (YYYY-MM-DD)

access_token

string (required) Example: 5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx

API access token

Response 200

HideShow

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "success": true,
  "usage_limit": {
    "used": 0.12,
    "limit": 1
  },
  "pagination": {
    "total": 12345,
    "limit": 50,
    "offset": 0
  },
  "data": [
    {
      "advertId": 123,
      "statsTotal": {
        "clicks": 600,
        "impressions": 4000,
        "spendings": 300000
      },
      "statsDetail": [
        {
          "date": "2017-05-30",
          "clicks": 100,
          "impressions": 1000,
          "spendings": 100000
        },
        {
          "date": "2017-05-31",
          "clicks": 500,
          "impressions": 3000,
          "spendings": 200000
        }
      ]
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "usage_limit": {
      "type": "object",
      "properties": {
        "used": {
          "type": "number"
        },
        "limit": {
          "type": "number"
        }
      },
      "required": [
        "used",
        "limit"
      ]
    },
    "pagination": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number"
        },
        "limit": {
          "type": "number"
        },
        "offset": {
          "type": "number"
        }
      },
      "required": [
        "total",
        "limit",
        "offset"
      ]
    },
    "data": {
      "type": "array"
    }
  },
  "required": [
    "success",
    "usage_limit",
    "pagination",
    "data"
  ]
}

Get stats for multi matches ¶

Note

This api provide statistics for matches by adverts ids

Multi Matches
GET`/matches/statistics{?access_token,start_date,end_date}`

Description

Example URI

GET https://api.qc.coccoc.com/v1/matches/statistics?access_token=5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx&start_date=2017-05-30&end_date=2017-05-31

URI Parameters

HideShow

id[]

array (required) Example: id[]=123

Advert IDs

For multi adverts: id[]=123&id[]=456

start_date

string (required) Example: 2017-05-30

Start of period date in ISO 8601 format (YYYY-MM-DD)

end_date

string (required) Example: 2017-05-31

End of period date in ISO 8601 format (YYYY-MM-DD)

access_token

string (required) Example: 5pien0GQkHSDxDOIXZdgVv8Ib95gWd3bw933QEVx

API access token

Response 200

HideShow

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "success": true,
  "usage_limit": {
    "used": 0.12,
    "limit": 1
  },
  "pagination": {
    "total": 12345,
    "limit": 50,
    "offset": 0
  },
  "data": [
    {
      "matchId": 4213,
      "statsTotal": {
        "clicks": 600,
        "impressions": 4000,
        "spendings": 300000
      },
      "statsPlacements": {
        "serp": {
          "clicks": 200,
          "impressions": 1000,
          "spendings": 100000
        },
        "newtab": {
          "clicks": 400,
          "impressions": 3000,
          "spendings": 200000
        }
      },
      "statsDetail": [
        {
          "date": "2017-05-30",
          "clicks": 100,
          "impressions": 1000,
          "spendings": 100000,
          "placement": "serp"
        },
        {
          "date": "2017-05-31",
          "clicks": 500,
          "impressions": 3000,
          "spendings": 200000,
          "placement": "newtab"
        },
        {
          "date": "2017-05-31",
          "clicks": 500,
          "impressions": 3000,
          "spendings": 200000,
          "placement": "newtab"
        }
      ]
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "usage_limit": {
      "type": "object",
      "properties": {
        "used": {
          "type": "number"
        },
        "limit": {
          "type": "number"
        }
      },
      "required": [
        "used",
        "limit"
      ]
    },
    "pagination": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number"
        },
        "limit": {
          "type": "number"
        },
        "offset": {
          "type": "number"
        }
      },
      "required": [
        "total",
        "limit",
        "offset"
      ]
    },
    "data": {
      "type": "array"
    }
  },
  "required": [
    "success",
    "usage_limit",
    "pagination",
    "data"
  ]
}

Available Data ¶

Demographics

List of available demographics

ID	Name
11190	Male
11191	Female
11192	0-14
11196	15-24
11197	25-34
11213	0-24
11214	15-34
11215	25-44
11216	35+
11201	Male 0-14
11202	Male 15-24
11203	Male 25-34
11217	Male 0-24
11218	Male 15-34
11219	Male 25-44
11220	Male 35+
11207	Female 0-14
11208	Female 15-24
11209	Female 25-34
11221	Female 0-24
11222	Female 15-34
11223	Female 25-44
11224	Female 35+

Interests

List of available interests:

ID	Name
1	Education
2	E-commerce
3	Beauty & cosmetics
4	Fashion
5	House keeping & family
6	Video-clip
7	Finance
8	Food
9	Game
10	Job
11	Health
12	Lottery
13	Music
14	Real estate
15	Dating
16	Travel
17	Vehicle
18	Marketing
19	Mobile
13981	Re-Targeting
13989	Competitors

Locations

List of available locations:

ID	Name	Level Name
1001000000	An Giang	Province
1001001000	An Phú, An Giang	District
1001002000	Chợ Mới, An Giang	District
1001003000	Châu Đốc, An Giang	City
1001004000	Châu Phú, An Giang	District
1001005000	Châu Thành, An Giang	District
1001006000	Long Xuyên, An Giang	City
1001007000	Phú Tân, An Giang	District
1001008000	Tịnh Biên, An Giang	District
1001009000	Tân Châu, An Giang	Town
1001010000	Thoại Sơn, An Giang	District
1001011000	Tri Tôn, An Giang	District
1002000000	Bạc Liêu	Province
1002001000	Bạc Liêu, Bạc Liêu	City
1002002000	Đông Hải, Bạc Liêu	District
1002003000	Giá Rai, Bạc Liêu	Town
1002004000	Hồng Dân, Bạc Liêu	District
1002005000	Hòa Bình, Bạc Liêu	District
1002006000	Phước Long, Bạc Liêu	District
1002007000	Vĩnh Lợi, Bạc Liêu	District
1003000000	Bắc Giang	Province
1003001000	Bắc Giang, Bắc Giang	City
1003002000	Hiệp Hòa, Bắc Giang	District
1003003000	Lạng Giang, Bắc Giang	District
1003004000	Lục Nam, Bắc Giang	District
1003005000	Lục Ngạn, Bắc Giang	District
1003006000	Sơn Động, Bắc Giang	District
1003007000	Tân Yên, Bắc Giang	District
1003008000	Việt Yên, Bắc Giang	District
1003009000	Yên Dũng, Bắc Giang	District
1003010000	Yên Thế, Bắc Giang	District
1004000000	Bắc Kạn	Province
1004001000	Bạch Thông, Bắc Kạn	District
1004002000	Ba Bể, Bắc Kạn	District
1004003000	Chợ Đồn, Bắc Kạn	District
1004004000	Chợ Mới, Bắc Kạn	District
1004005000	Na Rì, Bắc Kạn	District
1004006000	Ngân Sơn, Bắc Kạn	District
1004007000	Pắc Nặm, Bắc Kạn	District
1004008000	Bắc Kạn, Bắc Kạn	City
1005000000	Bắc Ninh	Province
1005001000	Bắc Ninh, Bắc Ninh	City
1005002000	Gia Bình, Bắc Ninh	District
1005003000	Lương Tài, Bắc Ninh	District
1005004000	Quế Võ, Bắc Ninh	District
1005005000	Từ Sơn, Bắc Ninh	Town
1005006000	Thuận Thành, Bắc Ninh	District
1005007000	Tiên Du, Bắc Ninh	District
1005008000	Yên Phong, Bắc Ninh	District
1006000000	Bến Tre	Province
1006001000	Bến Tre, Bến Tre	City
1006002000	Ba Tri, Bến Tre	District
1006003000	Bình Đại, Bến Tre	District
1006004000	Chợ Lách, Bến Tre	District
1006005000	Châu Thành, Bến Tre	District
1006006000	Giồng Trôm, Bến Tre	District
1006007000	Mỏ Cày Bắc, Bến Tre	District
1006008000	Mỏ Cày Nam, Bến Tre	District
1006009000	Thạnh Phú, Bến Tre	District
1007000000	Bà Rịa-Vũng Tàu	Province
1007001000	Bà Rịa, Bà Rịa-Vũng Tàu	City
1007002000	Châu Đức, Bà Rịa-Vũng Tàu	District
1007003000	Đất Đỏ, Bà Rịa-Vũng Tàu	District
1007004000	Long Điền, Bà Rịa-Vũng Tàu	District
1007005000	Tân Thành, Bà Rịa-Vũng Tàu	District
1007006000	Vũng Tàu, Bà Rịa-Vũng Tàu	City
1007007000	Xuyên Mộc, Bà Rịa-Vũng Tàu	District
1008000000	Bình Định	Province
1008001000	An Lão, Bình Định	District
1008002000	An Nhơn, Bình Định	Town
1008003000	Hoài Ân, Bình Định	District
1008004000	Hoài Nhơn, Bình Định	District
1008005000	Phù Cát, Bình Định	District
1008006000	Phù Mỹ, Bình Định	District
1008007000	Quy Nhơn, Bình Định	City
1008008000	Tây Sơn, Bình Định	District
1008009000	Tuy Phước, Bình Định	District
1008010000	Vân Canh, Bình Định	District
1008011000	Vĩnh Thạnh, Bình Định	District
1009000000	Bình Dương	Province
1009001000	Bắc Tân Uyên, Bình Dương	District
1009002000	Bến Cát, Bình Dương	Town
1009003000	Bàu Bàng, Bình Dương	District
1009004000	Dầu Tiếng, Bình Dương	District
1009005000	Dĩ An, Bình Dương	Town
1009006000	Phú Giáo, Bình Dương	District
1009007000	Tân Uyên, Bình Dương	Town
1009008000	Thủ Dầu Một, Bình Dương	City
1009009000	Thuận An, Bình Dương	Town
1010000000	Bình Phước	Province
1010001000	Bình Long, Bình Phước	Town
1010002000	Bù Đốp, Bình Phước	District
1010003000	Bù Đăng, Bình Phước	District
1010004000	Bù Gia Mập, Bình Phước	District
1010005000	Chơn Thành, Bình Phước	District
1010006000	Đồng Phú, Bình Phước	District
1010007000	Đồng Xoài, Bình Phước	City
1010008000	Hớn Quản, Bình Phước	District
1010009000	Lộc Ninh, Bình Phước	District
1010010000	Phú Riềng, Bình Phước	District
1010011000	Phước Long, Bình Phước	Town
1011000000	Bình Thuận	Province
1011001000	Bắc Bình, Bình Thuận	District
1011002000	Đức Linh, Bình Thuận	District
1011003000	Hàm Tân, Bình Thuận	District
1011004000	Hàm Thuận Bắc, Bình Thuận	District
1011005000	Hàm Thuận Nam, Bình Thuận	District
1011006000	La Gi, Bình Thuận	Town
1011007000	Phan Thiết, Bình Thuận	City
1011008000	Phú Quý, Bình Thuận	District
1011009000	Tánh Linh, Bình Thuận	District
1011010000	Tuy Phong, Bình Thuận	District
1012000000	Cần Thơ	City Of Nation
1012001000	Bình Thuỷ, Cần Thơ	Urban District
1012002000	Cờ Đỏ, Cần Thơ	District
1012003000	Cái Răng, Cần Thơ	Urban District
1012004000	Ninh Kiều, Cần Thơ	Urban District
1012005000	Ô Môn, Cần Thơ	Urban District
1012006000	Phong Điền, Cần Thơ	District
1012007000	Thốt Nốt, Cần Thơ	Urban District
1012008000	Thới Lai, Cần Thơ	District
1012009000	Vĩnh Thạnh, Cần Thơ	District
1013000000	Cà Mau	Province
1013001000	Cà Mau, Cà Mau	City
1013002000	Cái Nước, Cà Mau	District
1013003000	Đầm Dơi, Cà Mau	District
1013004000	Năm Căn, Cà Mau	District
1013005000	Ngọc Hiển, Cà Mau	District
1013006000	Phú Tân, Cà Mau	District
1013007000	Thới Bình, Cà Mau	District
1013008000	Trần Văn Thời, Cà Mau	District
1013009000	U Minh, Cà Mau	District
1014000000	Cao Bằng	Province
1014001000	Bảo Lạc, Cao Bằng	District
1014002000	Bảo Lâm, Cao Bằng	District
1014003000	Cao Bằng, Cao Bằng	City
1014004000	Hạ Lang, Cao Bằng	District
1014005000	Hà Quảng, Cao Bằng	District
1014006000	Hòa An, Cao Bằng	District
1014007000	Nguyên Bình, Cao Bằng	District
1014008000	Phục Hòa, Cao Bằng	District
1014009000	Quảng Uyên, Cao Bằng	District
1014010000	Thạch An, Cao Bằng	District
1014011000	Thông Nông, Cao Bằng	District
1014012000	Trà Lĩnh, Cao Bằng	District
1014013000	Trùng Khánh, Cao Bằng	District
1015000000	Đắk Lắk	Province
1015001000	Buôn Đôn, Đắk Lắk	District
1015002000	Buôn Ma Thuột, Đắk Lắk	City
1015003000	Cư Kuin, Đắk Lắk	District
1015004000	Cư M’gar, Đắk Lắk	District
1015005000	Ea H’leo, Đắk Lắk	District
1015006000	Ea Kar, Đắk Lắk	District
1015007000	Ea Súp, Đắk Lắk	District
1015008000	Krông Ana, Đắk Lắk	District
1015009000	Krông Bông, Đắk Lắk	District
1015010000	Krông Búk, Đắk Lắk	District
1015011000	Krông Năng, Đắk Lắk	District
1015012000	Krông Pắc, Đắk Lắk	District
1015013000	Lắk, Đắk Lắk	District
1015014000	M’đrắk, Đắk Lắk	District
1015015000	Buôn Hồ, Đắk Lắk	Town
1016000000	Đắk Nông	Province
1016001000	Cư Jút, Đắk Nông	District
1016002000	Đắk Mil, Đắk Nông	District
1016003000	Đắk R’lấp, Đắk Nông	District
1016004000	Đắk Song, Đắk Nông	District
1016005000	Đăk Glong, Đắk Nông	District
1016006000	Gia Nghĩa, Đắk Nông	Town
1016007000	Krông Nô, Đắk Nông	District
1016008000	Tuy Đức, Đắk Nông	District
1017000000	Đồng Nai	Province
1017001000	Biên Hòa, Đồng Nai	City
1017002000	Cẩm Mỹ, Đồng Nai	District
1017003000	Định Quán, Đồng Nai	District
1017004000	Long Khánh, Đồng Nai	City
1017005000	Long Thành, Đồng Nai	District
1017006000	Nhơn Trạch, Đồng Nai	District
1017007000	Tân Phú, Đồng Nai	District
1017008000	Thống Nhất, Đồng Nai	District
1017009000	Trảng Bom, Đồng Nai	District
1017010000	Vĩnh Cửu, Đồng Nai	District
1017011000	Xuân Lộc, Đồng Nai	District
1018000000	Đồng Tháp	Province
1018001000	Cao Lãnh (Thành Phố), Đồng Tháp	City
1018002000	Cao Lãnh, Đồng Tháp	District
1018003000	Châu Thành, Đồng Tháp	District
1018004000	Hồng Ngự (Thị Xã), Đồng Tháp	Town
1018005000	Hồng Ngự, Đồng Tháp	District
1018006000	Lấp Vò, Đồng Tháp	District
1018007000	Lai Vung, Đồng Tháp	District
1018008000	Sa Đéc, Đồng Tháp	City
1018009000	Tam Nông, Đồng Tháp	District
1018010000	Tân Hồng, Đồng Tháp	District
1018011000	Thanh Bình, Đồng Tháp	District
1018012000	Tháp Mười, Đồng Tháp	District
1019000000	Đà Nẵng	City Of Nation
1019001000	Cẩm Lệ, Đà Nẵng	Urban District
1019002000	Hải Châu, Đà Nẵng	Urban District
1019003000	Hòa Vang, Đà Nẵng	District
1019004000	Liên Chiểu, Đà Nẵng	Urban District
1019005000	Ngũ Hành Sơn, Đà Nẵng	Urban District
1019006000	Sơn Trà, Đà Nẵng	Urban District
1019007000	Thanh Khê, Đà Nẵng	Urban District
1020000000	Điện Biên	Province
1020001000	Điện Biên Đông, Điện Biên	District
1020002000	Điện Biên Phủ, Điện Biên	City
1020003000	Điện Biên, Điện Biên	District
1020004000	Mường Ảng, Điện Biên	District
1020005000	Mường Chà, Điện Biên	District
1020006000	Mường Nhé, Điện Biên	District
1020007000	Nậm Pồ, Điện Biên	District
1020008000	Tủa Chùa, Điện Biên	District
1020009000	Mường Lay, Điện Biên	Town
1020010000	Tuần Giáo, Điện Biên	District
1021000000	Gia Lai	Province
1021001000	An Khê, Gia Lai	Town
1021002000	Ayun Pa, Gia Lai	Town
1021003000	Chư Păh, Gia Lai	District
1021004000	Chư Prông, Gia Lai	District
1021005000	Chư Pưh, Gia Lai	District
1021006000	Chư Sê, Gia Lai	District
1021007000	Đức Cơ, Gia Lai	District
1021008000	Đắk Đoa, Gia Lai	District
1021009000	Đăk Pơ, Gia Lai	District
1021010000	Ia Grai, Gia Lai	District
1021011000	Ia Pa, Gia Lai	District
1021012000	K’bang, Gia Lai	District
1021013000	Kông Chro, Gia Lai	District
1021014000	Krông Pa, Gia Lai	District
1021015000	Mang Yang, Gia Lai	District
1021016000	Phú Thiện, Gia Lai	District
1021017000	Pleiku, Gia Lai	City
1022000000	Hải Dương	Province
1022001000	Bình Giang, Hải Dương	District
1022002000	Cẩm Giàng, Hải Dương	District
1022003000	Chí Linh, Hải Dương	City
1022004000	Gia Lộc, Hải Dương	District
1022005000	Hải Dương, Hải Dương	City
1022006000	Kim Thành, Hải Dương	District
1022007000	Kinh Môn, Hải Dương	Town
1022008000	Nam Sách, Hải Dương	District
1022009000	Ninh Giang, Hải Dương	District
1022010000	Tứ Kỳ, Hải Dương	District
1022011000	Thanh Hà, Hải Dương	District
1022012000	Thanh Miện, Hải Dương	District
1023000000	Hải Phòng	City Of Nation
1023001000	An Dương, Hải Phòng	District
1023002000	An Lão, Hải Phòng	District
1023003000	Bạch Long Vĩ, Hải Phòng	District
1023004000	Cát Hải, Hải Phòng	Urban District
1023005000	Đồ Sơn, Hải Phòng	Urban District
1023006000	Dương Kinh, Hải Phòng	Urban District
1023007000	Hải An, Hải Phòng	Urban District
1023008000	Hồng Bàng, Hải Phòng	Urban District
1023009000	Kiến An, Hải Phòng	Urban District
1023010000	Kiến Thuỵ, Hải Phòng	District
1023011000	Lê Chân, Hải Phòng	Urban District
1023012000	Ngô Quyền, Hải Phòng	Urban District
1023013000	Thuỷ Nguyên, Hải Phòng	District
1023014000	Tiên Lãng, Hải Phòng	District
1023015000	Vĩnh Bảo, Hải Phòng	District
1024000000	Hậu Giang	Province
1024001000	Châu Thành A, Hậu Giang	District
1024002000	Châu Thành, Hậu Giang	District
1024003000	Long Mỹ (Thị Xã), Hậu Giang	Town
1024004000	Long Mỹ, Hậu Giang	District
1024005000	Ngã Bảy, Hậu Giang	Town
1024006000	Phụng Hiệp, Hậu Giang	District
1024007000	Vị Thanh, Hậu Giang	City
1024008000	Vị Thủy, Hậu Giang	District
1025000000	Hồ Chí Minh	City Of Nation
1025001000	Bình Chánh, Hồ Chí Minh	District
1025002000	Bình Tân, Hồ Chí Minh	Urban District
1025003000	Bình Thạnh, Hồ Chí Minh	Urban District
1025004000	Cần Giờ, Hồ Chí Minh	District
1025005000	Củ Chi, Hồ Chí Minh	District
1025006000	Gò Vấp, Hồ Chí Minh	Urban District
1025007000	Hóc Môn, Hồ Chí Minh	District
1025008000	Nhà Bè, Hồ Chí Minh	District
1025009000	Phú Nhuận, Hồ Chí Minh	Urban District
1025010000	Quận 10, Hồ Chí Minh	Urban District
1025011000	Quận 11, Hồ Chí Minh	Urban District
1025012000	Quận 12, Hồ Chí Minh	Urban District
1025013000	Quận 1, Hồ Chí Minh	Urban District
1025014000	Quận 2, Hồ Chí Minh	Urban District
1025015000	Quận 3, Hồ Chí Minh	Urban District
1025016000	Quận 4, Hồ Chí Minh	Urban District
1025017000	Quận 5, Hồ Chí Minh	Urban District
1025018000	Quận 6, Hồ Chí Minh	Urban District
1025019000	Quận 7, Hồ Chí Minh	Urban District
1025020000	Quận 8, Hồ Chí Minh	Urban District
1025021000	Quận 9, Hồ Chí Minh	Urban District
1025022000	Tân Bình, Hồ Chí Minh	Urban District
1025023000	Tân Phú, Hồ Chí Minh	Urban District
1025024000	Thủ Đức, Hồ Chí Minh	Urban District
1026000000	Hà Giang	Province
1026001000	Bắc Mê, Hà Giang	District
1026002000	Bắc Quang, Hà Giang	District
1026003000	Đồng Văn, Hà Giang	District
1026004000	Hà Giang, Hà Giang	City
1026005000	Hoàng Su Phì, Hà Giang	District
1026006000	Mèo Vạc, Hà Giang	District
1026007000	Quản Bạ, Hà Giang	District
1026008000	Quang Bình, Hà Giang	District
1026009000	Vị Xuyên, Hà Giang	District
1026010000	Xín Mần, Hà Giang	District
1026011000	Yên Minh, Hà Giang	District
1027000000	Hà Nội	City Of Nation
1027001000	Ứng Hòa, Hà Nội	District
1027002000	Bắc Từ Liêm, Hà Nội	Urban District
1027003000	Ba Đình, Hà Nội	Urban District
1027004000	Ba Vì, Hà Nội	District
1027005000	Cầu Giấy, Hà Nội	Urban District
1027006000	Chương Mỹ, Hà Nội	District
1027007000	Đống Đa, Hà Nội	Urban District
1027008000	Đan Phượng, Hà Nội	District
1027009000	Đông Anh, Hà Nội	District
1027010000	Gia Lâm, Hà Nội	District
1027011000	Hà Đông, Hà Nội	Urban District
1027012000	Hai Bà Trưng, Hà Nội	Urban District
1027013000	Hoài Đức, Hà Nội	District
1027014000	Hoàn Kiếm, Hà Nội	Urban District
1027015000	Hoàng Mai, Hà Nội	Urban District
1027016000	Long Biên, Hà Nội	Urban District
1027017000	Mỹ Đức, Hà Nội	District
1027018000	Mê Linh, Hà Nội	District
1027019000	Nam Từ Liêm, Hà Nội	Urban District
1027020000	Phú Xuyên, Hà Nội	District
1027021000	Phúc Thọ, Hà Nội	District
1027022000	Quốc Oai, Hà Nội	District
1027023000	Sóc Sơn, Hà Nội	District
1027024000	Sơn Tây, Hà Nội	Town
1027025000	Tây Hồ, Hà Nội	Urban District
1027026000	Thạch Thất, Hà Nội	District
1027027000	Thanh Oai, Hà Nội	District
1027028000	Thanh Trì, Hà Nội	District
1027029000	Thanh Xuân, Hà Nội	Urban District
1027030000	Thường Tín, Hà Nội	District
1028000000	Hà Nam	Province
1028001000	Bình Lục, Hà Nam	District
1028002000	Duy Tiên, Hà Nam	District
1028003000	Kim Bảng, Hà Nam	District
1028004000	Lý Nhân, Hà Nam	District
1028005000	Phủ Lý, Hà Nam	City
1028006000	Thanh Liêm, Hà Nam	District
1029000000	Hà Tĩnh	Province
1029001000	Cẩm Xuyên, Hà Tĩnh	District
1029002000	Can Lộc, Hà Tĩnh	District
1029003000	Đức Thọ, Hà Tĩnh	District
1029004000	Hồng Lĩnh, Hà Tĩnh	Town
1029005000	Hà Tĩnh, Hà Tĩnh	City
1029006000	Hương Khê, Hà Tĩnh	District
1029007000	Hương Sơn, Hà Tĩnh	District
1029008000	Kỳ Anh (Thị Xã), Hà Tĩnh	Town
1029009000	Kỳ Anh, Hà Tĩnh	District
1029010000	Lộc Hà, Hà Tĩnh	District
1029011000	Nghi Xuân, Hà Tĩnh	District
1029012000	Thạch Hà, Hà Tĩnh	District
1029013000	Vũ Quang, Hà Tĩnh	District
1030000000	Hòa Bình	Province
1030001000	Cao Phong, Hòa Bình	District
1030002000	Đà Bắc, Hòa Bình	District
1030003000	Hòa Bình, Hòa Bình	City
1030004000	Kỳ Sơn, Hòa Bình	District
1030005000	Kim Bôi, Hòa Bình	District
1030006000	Lạc Sơn, Hòa Bình	District
1030007000	Lạc Thủy, Hòa Bình	District
1030008000	Lương Sơn, Hòa Bình	District
1030009000	Mai Châu, Hòa Bình	District
1030010000	Tân Lạc, Hòa Bình	District
1030011000	Yên Thủy, Hòa Bình	District
1031000000	Hưng Yên	Province
1031001000	Ân Thi, Hưng Yên	District
1031002000	Hưng Yên, Hưng Yên	City
1031003000	Khoái Châu, Hưng Yên	District
1031004000	Kim Động, Hưng Yên	District
1031005000	Mỹ Hào, Hưng Yên	Town
1031006000	Phù Cừ, Hưng Yên	District
1031007000	Tiên Lữ, Hưng Yên	District
1031008000	Văn Giang, Hưng Yên	District
1031009000	Văn Lâm, Hưng Yên	District
1031010000	Yên Mỹ, Hưng Yên	District
1032000000	Khánh Hòa	Province
1032001000	Cam Lâm, Khánh Hòa	District
1032002000	Cam Ranh, Khánh Hòa	City
1032003000	Diên Khánh, Khánh Hòa	District
1032004000	Khánh Sơn, Khánh Hòa	District
1032005000	Khánh Vĩnh, Khánh Hòa	District
1032006000	Nha Trang, Khánh Hòa	City
1032007000	Ninh Hòa, Khánh Hòa	Town
1032008000	Vạn Ninh, Khánh Hòa	District
1033000000	Kiên Giang	Province
1033001000	An Biên, Kiên Giang	District
1033002000	An Minh, Kiên Giang	District
1033003000	Châu Thành, Kiên Giang	District
1033004000	Giồng Riềng, Kiên Giang	District
1033005000	Giang Thành, Kiên Giang	District
1033006000	Gò Quao, Kiên Giang	District
1033007000	Hà Tiên, Kiên Giang	City
1033008000	Hòn Đất, Kiên Giang	District
1033009000	Kiên Hải, Kiên Giang	District
1033010000	Kiên Lương, Kiên Giang	District
1033011000	Phú Quốc, Kiên Giang	District
1033012000	Rạch Giá, Kiên Giang	City
1033013000	Tân Hiệp, Kiên Giang	District
1033014000	U Minh Thượng, Kiên Giang	District
1033015000	Vĩnh Thuận, Kiên Giang	District
1034000000	Kon Tum	Province
1034001000	Đắk Glei, Kon Tum	District
1034002000	Đắk Hà, Kon Tum	District
1034003000	Đắk Tô, Kon Tum	District
1034004000	Ia H’ Drai, Kon Tum	District
1034005000	Kon Plông, Kon Tum	District
1034006000	Kon Rẫy, Kon Tum	District
1034007000	Kon Tum, Kon Tum	City
1034008000	Ngọc Hồi, Kon Tum	District
1034009000	Sa Thầy, Kon Tum	District
1034010000	Tu Mơ Rông, Kon Tum	District
1035000000	Lạng Sơn	Province
1035001000	Bắc Sơn, Lạng Sơn	District
1035002000	Bình Gia, Lạng Sơn	District
1035003000	Cao Lộc, Lạng Sơn	District
1035004000	Chi Lăng, Lạng Sơn	District
1035005000	Đình Lập, Lạng Sơn	District
1035006000	Hữu Lũng, Lạng Sơn	District
1035007000	Lạng Sơn, Lạng Sơn	City
1035008000	Lộc Bình, Lạng Sơn	District
1035009000	Tràng Định, Lạng Sơn	District
1035010000	Văn Lãng, Lạng Sơn	District
1035011000	Văn Quan, Lạng Sơn	District
1036000000	Lai Châu	Province
1036001000	Lai Châu, Lai Châu	City
1036002000	Mường Tè, Lai Châu	District
1036003000	Nậm Nhùn, Lai Châu	District
1036004000	Phong Thổ, Lai Châu	District
1036005000	Sìn Hồ, Lai Châu	District
1036006000	Tam Đường, Lai Châu	District
1036007000	Tân Uyên, Lai Châu	District
1036008000	Than Uyên, Lai Châu	District
1037000000	Lâm Đồng	Province
1037001000	Bảo Lộc, Lâm Đồng	City
1037002000	Bảo Lâm, Lâm Đồng	District
1037003000	Cát Tiên, Lâm Đồng	District
1037004000	Đạ Huoai, Lâm Đồng	District
1037005000	Đạ Tẻh, Lâm Đồng	District
1037006000	Đức Trọng, Lâm Đồng	District
1037007000	Đà Lạt, Lâm Đồng	City
1037008000	Đam Rông, Lâm Đồng	District
1037009000	Di Linh, Lâm Đồng	District
1037010000	Đơn Dương, Lâm Đồng	District
1037011000	Lạc Dương, Lâm Đồng	District
1037012000	Lâm Hà, Lâm Đồng	District
1038000000	Lào Cai	Province
1038001000	Bảo Thắng, Lào Cai	District
1038002000	Bảo Yên, Lào Cai	District
1038003000	Bắc Hà, Lào Cai	District
1038004000	Bát Xát, Lào Cai	District
1038005000	Lào Cai, Lào Cai	City
1038006000	Mường Khương, Lào Cai	District
1038007000	Sa Pa, Lào Cai	Town
1038008000	Si Ma Cai, Lào Cai	District
1038009000	Văn Bàn, Lào Cai	District
1039000000	Long An	Province
1039001000	Bến Lức, Long An	District
1039002000	Cần Đước, Long An	District
1039003000	Cần Giuộc, Long An	District
1039004000	Châu Thành, Long An	District
1039005000	Đức Hòa, Long An	District
1039006000	Đức Huệ, Long An	District
1039007000	Kiến Tường, Long An	District
1039008000	Mộc Hóa, Long An	District
1039009000	Tân An, Long An	City
1039010000	Tân Hưng, Long An	District
1039011000	Tân Thạnh, Long An	District
1039012000	Tân Trụ, Long An	District
1039013000	Thạnh Hóa, Long An	District
1039014000	Thủ Thừa, Long An	District
1039015000	Vĩnh Hưng, Long An	District
1040000000	Nam Định	Province
1040001000	Giao Thủy, Nam Định	District
1040002000	Hải Hậu, Nam Định	District
1040003000	Mỹ Lộc, Nam Định	District
1040004000	Nam Định, Nam Định	City
1040005000	Nam Trực, Nam Định	District
1040006000	Nghĩa Hưng, Nam Định	District
1040007000	Trực Ninh, Nam Định	District
1040008000	Vụ Bản, Nam Định	District
1040009000	Xuân Trường, Nam Định	District
1040010000	Ý Yên, Nam Định	District
1041000000	Nghệ An	Province
1041001000	Anh Sơn, Nghệ An	District
1041002000	Cửa Lò, Nghệ An	Town
1041003000	Con Cuông, Nghệ An	District
1041004000	Diễn Châu, Nghệ An	District
1041005000	Đô Lương, Nghệ An	District
1041006000	Hoàng Mai, Nghệ An	Town
1041007000	Hưng Nguyên, Nghệ An	District
1041008000	Kỳ Sơn, Nghệ An	District
1041009000	Nam Đàn, Nghệ An	District
1041010000	Nghi Lộc, Nghệ An	District
1041011000	Nghĩa Đàn, Nghệ An	District
1041012000	Quế Phong, Nghệ An	District
1041013000	Quỳ Châu, Nghệ An	District
1041014000	Quỳ Hợp, Nghệ An	District
1041015000	Quỳnh Lưu, Nghệ An	District
1041016000	Tân Kỳ, Nghệ An	District
1041017000	Thái Hòa, Nghệ An	Town
1041018000	Thanh Chương, Nghệ An	District
1041019000	Tương Dương, Nghệ An	District
1041020000	Vinh, Nghệ An	City
1041021000	Yên Thành, Nghệ An	District
1042000000	Ninh Bình	Province
1042001000	Gia Viễn, Ninh Bình	District
1042002000	Hoa Lư, Ninh Bình	District
1042003000	Kim Sơn, Ninh Bình	District
1042004000	Nho Quan, Ninh Bình	District
1042005000	Ninh Bình, Ninh Bình	City
1042006000	Tam Điệp, Ninh Bình	City
1042007000	Yên Khánh, Ninh Bình	District
1042008000	Yên Mô, Ninh Bình	District
1043000000	Ninh Thuận	Province
1043001000	Bác Ái, Ninh Thuận	District
1043002000	Ninh Hải, Ninh Thuận	District
1043003000	Ninh Phước, Ninh Thuận	District
1043004000	Ninh Sơn, Ninh Thuận	District
1043005000	Phan Rang-Tháp Chàm, Ninh Thuận	City
1043006000	Thuận Bắc, Ninh Thuận	District
1043007000	Thuận Nam, Ninh Thuận	District
1044000000	Phú Thọ	Province
1044001000	Cẩm Khê, Phú Thọ	District
1044002000	Đoan Hùng, Phú Thọ	District
1044003000	Hạ Hoà, Phú Thọ	District
1044004000	Lâm Thao, Phú Thọ	District
1044005000	Phù Ninh, Phú Thọ	District
1044006000	Phú Thọ, Phú Thọ	Town
1044007000	Tam Nông, Phú Thọ	District
1044008000	Tân Sơn, Phú Thọ	District
1044009000	Thanh Ba, Phú Thọ	District
1044010000	Thanh Sơn, Phú Thọ	District
1044011000	Thanh Thủy, Phú Thọ	District
1044012000	Việt Trì, Phú Thọ	City
1044013000	Yên Lập, Phú Thọ	District
1045000000	Phú Yên	Province
1045001000	Đồng Xuân, Phú Yên	District
1045002000	Đông Hòa, Phú Yên	District
1045003000	Phú Hoà, Phú Yên	District
1045004000	Sơn Hòa, Phú Yên	District
1045005000	Sông Cầu, Phú Yên	Town
1045006000	Sông Hinh, Phú Yên	District
1045007000	Tây Hoà, Phú Yên	District
1045008000	Tuy An, Phú Yên	District
1045009000	Tuy Hòa, Phú Yên	City
1046000000	Quảng Bình	Province
1046001000	Bố Trạch, Quảng Bình	District
1046002000	Ba Đồn, Quảng Bình	Town
1046003000	Lệ Thủy, Quảng Bình	District
1046004000	Minh Hóa, Quảng Bình	District
1046005000	Quảng Ninh, Quảng Bình	District
1046006000	Quảng Trạch, Quảng Bình	District
1046007000	Đồng Hới, Quảng Bình	City
1046008000	Tuyên Hóa, Quảng Bình	District
1047000000	Quảng Nam	Province
1047001000	Bắc Trà My, Quảng Nam	District
1047002000	Đại Lộc, Quảng Nam	District
1047003000	Điện Bàn, Quảng Nam	Town
1047004000	Đông Giang, Quảng Nam	District
1047005000	Duy Xuyên, Quảng Nam	District
1047006000	Hội An, Quảng Nam	City
1047007000	Hiệp Đức, Quảng Nam	District
1047008000	Nam Giang, Quảng Nam	District
1047009000	Nam Trà My, Quảng Nam	District
1047010000	Nông Sơn, Quảng Nam	District
1047011000	Núi Thành, Quảng Nam	District
1047012000	Phú Ninh, Quảng Nam	District
1047013000	Phước Sơn, Quảng Nam	District
1047014000	Quế Sơn, Quảng Nam	District
1047015000	Tam Kỳ, Quảng Nam	City
1047016000	Tây Giang, Quảng Nam	District
1047017000	Thăng Bình, Quảng Nam	District
1047018000	Tiên Phước, Quảng Nam	District
1048000000	Quảng Ngãi	Province
1048001000	Ba Tơ, Quảng Ngãi	District
1048002000	Bình Sơn, Quảng Ngãi	District
1048003000	Đức Phổ, Quảng Ngãi	District
1048004000	Lý Sơn, Quảng Ngãi	District
1048005000	Mộ Đức, Quảng Ngãi	District
1048006000	Minh Long, Quảng Ngãi	District
1048007000	Nghĩa Hành, Quảng Ngãi	District
1048008000	Quảng Ngãi, Quảng Ngãi	City
1048009000	Sơn Hà, Quảng Ngãi	District
1048010000	Sơn Tịnh, Quảng Ngãi	District
1048011000	Sơn Tây, Quảng Ngãi	District
1048012000	Tây Trà, Quảng Ngãi	District
1048013000	Trà Bồng, Quảng Ngãi	District
1048014000	Tư Nghĩa, Quảng Ngãi	District
1049000000	Quảng Ninh	Province
1049001000	Ba Chẽ, Quảng Ninh	District
1049002000	Bình Liêu, Quảng Ninh	District
1049003000	Cẩm Phả, Quảng Ninh	City
1049004000	Cô Tô, Quảng Ninh	District
1049005000	Đầm Hà, Quảng Ninh	District
1049006000	Đông Triều, Quảng Ninh	Town
1049007000	Hạ Long, Quảng Ninh	City
1049008000	Hải Hà, Quảng Ninh	District
1049009000	Hoành Bồ, Quảng Ninh	District
1049010000	Móng Cái, Quảng Ninh	City
1049011000	Quảng Yên, Quảng Ninh	Town
1049012000	Tiên Yên, Quảng Ninh	District
1049013000	Uông Bí, Quảng Ninh	City
1049014000	Vân Đồn, Quảng Ninh	District
1050000000	Quảng Trị	Province
1050001000	Cồn Cỏ, Quảng Trị	District
1050002000	Cam Lộ, Quảng Trị	District
1050003000	Đa Krông, Quảng Trị	District
1050004000	Đông Hà, Quảng Trị	City
1050005000	Gio Linh, Quảng Trị	District
1050006000	Hải Lăng, Quảng Trị	District
1050007000	Hướng Hóa, Quảng Trị	District
1050008000	Quảng Trị, Quảng Trị	Town
1050009000	Triệu Phong, Quảng Trị	District
1050010000	Vĩnh Linh, Quảng Trị	District
1051000000	Sóc Trăng	Province
1051001000	Châu Thành, Sóc Trăng	District
1051002000	Cù Lao Dung, Sóc Trăng	District
1051003000	Kế Sách, Sóc Trăng	District
1051004000	Long Phú, Sóc Trăng	District
1051005000	Mỹ Tú, Sóc Trăng	District
1051006000	Mỹ Xuyên, Sóc Trăng	District
1051007000	Ngã Năm, Sóc Trăng	Town
1051008000	Sóc Trăng, Sóc Trăng	City
1051009000	Thạnh Trị, Sóc Trăng	District
1051010000	Trần Đề, Sóc Trăng	District
1051011000	Vĩnh Châu, Sóc Trăng	Town
1052000000	Sơn La	Province
1052001000	Bắc Yên, Sơn La	District
1052002000	Mộc Châu, Sơn La	District
1052003000	Mai Sơn, Sơn La	District
1052004000	Mường La, Sơn La	District
1052005000	Phù Yên, Sơn La	District
1052006000	Quỳnh Nhai, Sơn La	District
1052007000	Sốp Cộp, Sơn La	District
1052008000	Sơn La, Sơn La	City
1052009000	Sông Mã, Sơn La	District
1052010000	Thuận Châu, Sơn La	District
1052011000	Vân Hồ, Sơn La	District
1052012000	Yên Châu, Sơn La	District
1053000000	Tây Ninh	Province
1053001000	Bến Cầu, Tây Ninh	District
1053002000	Châu Thành, Tây Ninh	District
1053003000	Dương Minh Châu, Tây Ninh	District
1053004000	Gò Dầu, Tây Ninh	District
1053005000	Hòa Thành, Tây Ninh	District
1053006000	Tân Biên, Tây Ninh	District
1053007000	Tân Châu, Tây Ninh	District
1053008000	Tây Ninh, Tây Ninh	City
1053009000	Trảng Bàng, Tây Ninh	District
1054000000	Thừa Thiên Huế	Province
1054001000	A Lưới, Thừa Thiên Huế	District
1054002000	Huế, Thừa Thiên Huế	City
1054003000	Hương Thủy, Thừa Thiên Huế	Town
1054004000	Hương Trà, Thừa Thiên Huế	Town
1054005000	Nam Đông, Thừa Thiên Huế	District
1054006000	Phong Điền, Thừa Thiên Huế	District
1054007000	Phú Lộc, Thừa Thiên Huế	District
1054008000	Phú Vang, Thừa Thiên Huế	District
1054009000	Quảng Điền, Thừa Thiên Huế	District
1055000000	Thái Bình	Province
1055001000	Đông Hưng, Thái Bình	District
1055002000	Hưng Hà, Thái Bình	District
1055003000	Kiến Xương, Thái Bình	District
1055004000	Quỳnh Phụ, Thái Bình	District
1055005000	Thái Bình, Thái Bình	City
1055006000	Thái Thụy, Thái Bình	District
1055007000	Tiền Hải, Thái Bình	District
1055008000	Vũ Thư, Thái Bình	District
1056000000	Thái Nguyên	Province
1056001000	Đại Từ, Thái Nguyên	District
1056002000	Định Hóa, Thái Nguyên	District
1056003000	Đồng Hỷ, Thái Nguyên	District
1056004000	Phổ Yên, Thái Nguyên	Town
1056005000	Phú Bình, Thái Nguyên	District
1056006000	Phú Lương, Thái Nguyên	District
1056007000	Sông Công, Thái Nguyên	City
1056008000	Thái Nguyên, Thái Nguyên	City
1056009000	Võ Nhai, Thái Nguyên	District
1057000000	Thanh Hóa	Province
1057001000	Bỉm Sơn, Thanh Hóa	Town
1057002000	Bá Thước, Thanh Hóa	District
1057003000	Cẩm Thủy, Thanh Hóa	District
1057004000	Đông Sơn, Thanh Hóa	District
1057005000	Hậu Lộc, Thanh Hóa	District
1057006000	Hà Trung, Thanh Hóa	District
1057007000	Hoằng Hóa, Thanh Hóa	District
1057008000	Lang Chánh, Thanh Hóa	District
1057009000	Mường Lát, Thanh Hóa	District
1057010000	Ngọc Lặc, Thanh Hóa	District
1057011000	Nga Sơn, Thanh Hóa	District
1057012000	Như Thanh, Thanh Hóa	District
1057013000	Như Xuân, Thanh Hóa	District
1057014000	Nông Cống, Thanh Hóa	District
1057015000	Quảng Xương, Thanh Hóa	District
1057016000	Quan Hóa, Thanh Hóa	District
1057017000	Quan Sơn, Thanh Hóa	District
1057018000	Sầm Sơn, Thanh Hóa	City
1057019000	Thạch Thành, Thanh Hóa	District
1057020000	Thọ Xuân, Thanh Hóa	District
1057021000	Thanh Hóa, Thanh Hóa	City
1057022000	Thiệu Hóa, Thanh Hóa	District
1057023000	Thường Xuân, Thanh Hóa	District
1057024000	Tĩnh Gia, Thanh Hóa	District
1057025000	Triệu Sơn, Thanh Hóa	District
1057026000	Vĩnh Lộc, Thanh Hóa	District
1057027000	Yên Định, Thanh Hóa	District
1058000000	Tiền Giang	Province
1058001000	Cái Bè, Tiền Giang	District
1058002000	Cai Lậy (Thị Xã), Tiền Giang	Town
1058003000	Cai Lậy, Tiền Giang	District
1058004000	Chợ Gạo, Tiền Giang	District
1058005000	Châu Thành, Tiền Giang	District
1058006000	Gò Công Đông, Tiền Giang	District
1058007000	Gò Công Tây, Tiền Giang	District
1058008000	Gò Công, Tiền Giang	Town
1058009000	Mỹ Tho, Tiền Giang	City
1058010000	Tân Phú Đông, Tiền Giang	District
1058011000	Tân Phước, Tiền Giang	District
1059000000	Trà Vinh	Province
1059001000	Cầu Kè, Trà Vinh	District
1059002000	Cầu Ngang, Trà Vinh	District
1059003000	Càng Long, Trà Vinh	District
1059004000	Châu Thành, Trà Vinh	District
1059005000	Duyên Hải (Thị Xã), Trà Vinh	Town
1059006000	Duyên Hải, Trà Vinh	District
1059007000	Tiểu Cần, Trà Vinh	District
1059008000	Trà Cú, Trà Vinh	District
1059009000	Trà Vinh, Trà Vinh	City
1060000000	Tuyên Quang	Province
1060001000	Chiêm Hóa, Tuyên Quang	District
1060002000	Hàm Yên, Tuyên Quang	District
1060003000	Lâm Bình, Tuyên Quang	District
1060004000	Nà Hang, Tuyên Quang	District
1060005000	Sơn Dương, Tuyên Quang	District
1060006000	Tuyên Quang, Tuyên Quang	City
1060007000	Yên Sơn, Tuyên Quang	District
1061000000	Vĩnh Long	Province
1061001000	Bình Minh, Vĩnh Long	Town
1061002000	Bình Tân, Vĩnh Long	District
1061003000	Long Hồ, Vĩnh Long	District
1061004000	Mang Thít, Vĩnh Long	District
1061005000	Tam Bình, Vĩnh Long	District
1061006000	Trà Ôn, Vĩnh Long	District
1061007000	Vĩnh Long, Vĩnh Long	City
1061008000	Vũng Liêm, Vĩnh Long	District
1062000000	Vĩnh Phúc	Province
1062001000	Bình Xuyên, Vĩnh Phúc	District
1062002000	Lập Thạch, Vĩnh Phúc	District
1062003000	Phúc Yên, Vĩnh Phúc	City
1062004000	Sông Lô, Vĩnh Phúc	District
1062005000	Tam Đảo, Vĩnh Phúc	District
1062006000	Tam Dương, Vĩnh Phúc	District
1062007000	Vĩnh Tường, Vĩnh Phúc	District
1062008000	Vĩnh Yên, Vĩnh Phúc	City
1062009000	Yên Lạc, Vĩnh Phúc	District
1063000000	Yên Bái	Province
1063001000	Lục Yên, Yên Bái	District
1063002000	Mù Cang Chải, Yên Bái	District
1063003000	Nghĩa Lộ, Yên Bái	Town
1063004000	Trạm Tấu, Yên Bái	District
1063005000	Trấn Yên, Yên Bái	District
1063006000	Văn Chấn, Yên Bái	District
1063007000	Văn Yên, Yên Bái	District
1063008000	Yên Bái, Yên Bái	City
1063009000	Yên Bình, Yên Bái	District

Interaction with resources ¶

Request ¶

Authentication ¶

Limits ¶

Response ¶

Response status codes ¶

Response body ¶

Campaigns ¶

Campaign ¶

Get campaignGET/campaigns/{id}{?access_token}

Example URI

Headers

Body

Schema

Update campaignPUT/campaigns/{id}{?access_token}

Example URI

Headers

Body

Headers

Body

Schema

Partial update campaignPATCH/campaigns/{id}{?access_token}

Example URI

Headers

Body

Headers

Body

Schema

Campaigns ¶

Get campaigns listGET/campaigns{?limit,offset}

Example URI

Headers

Body

Schema

Create campaignPOST/campaigns{?access_token}

Example URI

Headers

Body

Headers

Body

Schema

Campaign Stats ¶

Get campaign stats (Deprecated)GET/campaigns/{id}/stats{?access_token,start_date,end_date}

DEPRECATED ¶

Example URI

Headers

Body

Schema

Adverts ¶

Advert ¶

Get advertGET/adverts/{id}{?access_token}

Example URI

Headers

Body

Schema

Update advertPUT/adverts/{id}{?access_token}

Example URI

Headers

Body

Headers

Body

Schema

Partial update advertPATCH/adverts/{id}{?access_token}

Example URI

Headers

Body

Headers

Body

Schema

Adverts ¶

Get adverts listGET/adverts{?campaign_id,limit,offset}

Example URI

Headers

Body

Schema

Create advertPOST/adverts{?access_token}

Example URI

Headers

Body

Headers

Interaction with resources

Request

Authentication

Limits

Response

Response status codes

Response body

Get campaign
GET`/campaigns/{id}{?access_token}`

Update campaign
PUT`/campaigns/{id}{?access_token}`

Partial update campaign
PATCH`/campaigns/{id}{?access_token}`

Get campaigns list
GET`/campaigns{?limit,offset}`

Create campaign
POST`/campaigns{?access_token}`

Get campaign stats (Deprecated)
GET`/campaigns/{id}/stats{?access_token,start_date,end_date}`

DEPRECATED

Get advert
GET`/adverts/{id}{?access_token}`

Update advert
PUT`/adverts/{id}{?access_token}`

Partial update advert
PATCH`/adverts/{id}{?access_token}`

Get adverts list
GET`/adverts{?campaign_id,limit,offset}`

Create advert
POST`/adverts{?access_token}`

Multi Campaigns
GET`/campaigns/statistics{?access_token,start_date,end_date}`

Multi Adverts
GET`/adverts/statistics{?access_token,start_date,end_date}`

Note

Multi Matches
GET`/matches/statistics{?access_token,start_date,end_date}`

Demographics

Interests

Locations