Skip to main content
POST
/
api
/
v1
/
analysis
/
trigger
/
{analysis_type}
Trigger Analysis By Type
curl --request POST \
  --url http://localhost:8000/api/v1/analysis/trigger/{analysis_type} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
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

Query Parameters

​
customer_id
integer
required
​
login_customer_id
integer | null
​
temperature
number
default:0.2

Response

Successful Response

The schema for the result of triggering an analysis.

​
success
boolean
required
​
message
string
required