Get placement reports

GET /accounts/{account_id}/reports/placements

Fetch reports for the observed placement domains 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 placements 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 placements by given query

  • placements[] array[string]

    Fetch all placement reports for the given array of placement domains.

  • status string

    Status of a placement

    Values are NORMAL, SUSPICIOUS, or BLOCKED.

Responses

  • 200

    Successful operation

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

      Placement domain identifier

    • status string

      The current status of the placement

    • total_clicks number

      Total number of clicks from this placement

    • normal_clicks number

      Total number of normal clicks from this placement

    • suspicious_clicks number

      Total number of suspicious clicks from this placement

    • flagged_clicks number

      Total number of flagged clicks from this placement

    • invalid_clicks number

      Total number of invalid clicks from this placement

    • first_seen string(date-time)

      Timestamp of the first occurrence of this placement

    • last_seen string(date-time)

      Timestamp of the last occurrence of this placement

    • last_campaign_id string

      The ID of the last campaign this placement interacted with

    • last_device_id string

      The ID of the last device this placement was reported with

    • last_country string

      The last country this placmenet was reported from

    • last_city string

      The last city this placement was reported from
GET /accounts/{account_id}/reports/placements 
curl \
 -X GET https://api.clickguard.com/accounts/{account_id}/reports/placements?period=TODAY \
 -H "X-API-KEY: $API_KEY"
Response examples (200) 
"{\n  \"placement\": \"youtube.com\",\n  \"status\": \"NORMAL\",\n  \"total_clicks\": 52,\n  \"normal_clicks\": 13,\n  \"invalid_clicks\": 24,\n  \"suspicious_clicks\": 10,\n  \"flagged_clicks\": 5,\n  \"first_seen\": \"2020-10-27T16:17:09.974Z\",\n  \"last_seen\": \"2021-03-02T16:22:34.578Z\",\n  \"last_campaign_id\": \"9263669976\",\n  \"last_device_id\": \"q1w2e3r4t5y6\",\n  \"last_country\": \"Australia\",\n  \"last_country_code\": \"AU\",\n  \"last_region\": \"Sunshine Coast (Queensland)\",\n  \"last_city\": \"Sunshine Coast\"\n}"
Response examples (200) 
[
  {
    "placement": "string",
    "status": "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",
    "last_campaign_id": "string",
    "last_device_id": "string",
    "last_country": "string",
    "last_city": "string"
  }
]