Keywords

Retreive a Keyword

Retreives an existing keyword.

Arguments

id required integer (32)

The ID of the keyword to retrieve.

Endpoint

GET /v3/keywords/:id

Response

json
 {
  "metadata": {
    "total_pages": 1,
    "total_records": 1
  },
  "data": {
    "id": 123,
    "date_created": "2015-03-30 10:06:24",
    "date_modified": "2015-03-31 9:32:19",
    "keyword_phrase": "test keyword",
    "primary_keyword": "false",
    "campaign_id": 123
  }
}

List all Keywords

Returns an array containing all available keywords.

Arguments

filter string

The full or partial text of a keyword to search for.

page integer (32)

The page to retrieve results from

limit integer (32)

The maximum number of records to return

order_by string

The field to order the results by

order_direction string

The direction of the sort if order_field is set. May be either asc or dsc.

Endpoint

GET /v3/keywords

Response

json
 {
  "metadata": {
    "total_pages": 1,
    "total_records": 1
  },
  "data": [
    {
      "id": 123,
      "date_created": "2015-03-30 10:06:24",
      "date_modified": "2015-03-31 9:32:19",
      "keyword_phrase": "test keyword",
      "primary_keyword": "false",
      "campaign_id": 123
    }
  ]
}