Skip to main content
POST
/
api
/
v1
/
brands
/
{brand_id}
/
dashboards
/
competitor-google-ads
/
refresh
Refresh Competitor Dashboard
curl --request POST \
  --url https://api.example.com/api/v1/brands/{brand_id}/dashboards/competitor-google-ads/refresh \
  --header 'Authorization: Bearer <token>'
{
  "enqueued": true,
  "throttled": true,
  "job_id": "<string>",
  "competitor_count": 0,
  "next_refresh_available_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
brand_id
string<uuid>
required

Response

Successful Response

Result of POST .../refresh -- the work runs off-request on the Redis queue, so this reports whether a job was enqueued or throttled, not the per-competitor outcome (poll the overview/spend reads for fresh data).

​
enqueued
boolean
required
​
throttled
boolean
required
​
job_id
string | null
​
competitor_count
integer
default:0
​
next_refresh_available_at
string<date-time> | null