Get keyword reports

GET /accounts/{account_id}/reports/keywords

Fetch reports for the observed keywords in the given period

Available on: AuditGUARD AlertGUARD PremiumGUARD EliteGUARD

Path parameters

Query parameters

  • period string Required

    Observed period for the report

    Values are TODAY, YESTERDAY, THIS_WEEK, LAST_WEEK, THIS_MONTH, LAST_MONTH, LAST_30_DAYS, or LAST_3_MONTHS.

  • sort string

    Sort the keywords by a specified parameter. Use '-' prefix to indicate a descending sort. Default: '-total_clicks'.

    Values are last_seen, first_seen, total_clicks, invalid_clicks, or flagged_clicks.

  • offset number

    Paginating parameter. Offset the result by a specified number. Default: 0.

  • limit number

    Paginating parameter. Limit the number of result by a specified number. Max: 100. Default: 50.

  • query string

    Search keywords by given query

  • ids[] array[string]

    Fetch all keyword reports for the given array of keyword IDs.

Responses

  • 200

    Successful operation

    Hide response attributes Show response attributes array[object]
    • id string

      Keyword ID from Google Ads

    • text string

      Keyword text value

    • total_clicks number

      Total number of clicks for this keyword

    • normal_clicks number

      Total number of normal clicks for this keyword

    • suspicious_clicks number

      Total number of suspicious clicks for this keyword

    • flagged_clicks number

      Total number of flagged clicks for this keyword

    • invalid_clicks number

      Total number of invalid clicks for this keyword

    • first_seen string(date-time)

      Timestamp of the first occurrence of this keyword

    • last_seen string(date-time)

      Timestamp of the last occurrence of this keyword
GET /accounts/{account_id}/reports/keywords 
curl \
 -X GET https://api.clickguard.com/accounts/{account_id}/reports/keywords?period=TODAY \
 -H "X-API-KEY: $API_KEY"
Response examples (200) 
"{\n  \"id\": \"540789309495\",\n  \"text\": \"my keyword\",\n  \"total_clicks\": 1,\n  \"normal_clicks\": 0,\n  \"invalid_clicks\": 0,\n  \"suspicious_clicks\": 0,\n  \"flagged_clicks\": 1,\n  \"first_seen\": \"2021-04-15T06:36:52.564Z\",\n  \"last_seen\": \"2021-04-15T06:36:52.564Z\"\n}"
Response examples (200) 
[
  {
    "id": "string",
    "text": "string",
    "total_clicks": 42.0,
    "normal_clicks": 42.0,
    "suspicious_clicks": 42.0,
    "flagged_clicks": 42.0,
    "invalid_clicks": 42.0,
    "first_seen": "2024-05-04T09:42:00+00:00",
    "last_seen": "2024-05-04T09:42:00+00:00"
  }
]