Skip to main content
GET
/
api
/
v1
/
analysis
Get Analyses
curl --request GET \
  --url http://localhost:8000/api/v1/analysis/ \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "google_ads_customer": {
      "id": 123,
      "descriptive_name": "<string>",
      "currency_code": "<string>",
      "time_zone": "<string>",
      "status": "<string>",
      "manager": true
    },
    "google_ads_login_customer_id": 123,
    "campaign": {
      "id": 123,
      "google_ads_customer_id": 123,
      "name": "<string>",
      "status": "<string>",
      "start_date": "2023-11-07T05:31:56Z",
      "channel_type": "<string>",
      "end_date": "2023-11-07T05:31:56Z"
    },
    "analysis_type": "keyword_pause",
    "delay": 123,
    "is_started": true,
    "is_completed": true,
    "is_failed": true,
    "message": "<string>",
    "error_message": "<string>",
    "data": {},
    "date_added": "2023-11-07T05:31:56Z",
    "date_updated": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
analysis_type
enum<string> | null

The types of analyses.

Available options:
keyword_pause,
negative_keyword,
double_check_keywords_to_pause,
headline,
description,
budget_migration,
pause_hours,
pause_locations,
search_terms
​
limit
integer
default:20
​
offset
integer
default:0

Response

Successful Response

​
id
integer
required
​
google_ads_customer
GoogleAdsCustomerSchema · object
required

The schema for a Google Ads customer.

​
google_ads_login_customer_id
integer | null
required
​
campaign
CampaignSchema · object
required

Schema for Campaign data

​
analysis_type
enum<string>
required

The types of analyses.

Available options:
keyword_pause,
negative_keyword,
double_check_keywords_to_pause,
headline,
description,
budget_migration,
pause_hours,
pause_locations,
search_terms
​
delay
integer
required
​
is_started
boolean
required
​
is_completed
boolean
required
​
is_failed
boolean
required
​
message
string | null
required
​
error_message
string | null
required
​
data
Data · object
required
​
date_added
string<date-time>
required
​
date_updated
string<date-time>
required