Skip to main content
GET
/
api
/
v1
/
subscriptions
/
modules
/
{module_id}
Get Plan Module
curl --request GET \
  --url http://localhost:8000/api/v1/subscriptions/modules/{module_id} \
  --header 'Authorization: Bearer <token>'
{
  "constraint": 123,
  "analysis_frequency_hours": 123,
  "id": 123,
  "date_added": "2023-11-07T05:31:56Z",
  "date_updated": "2023-11-07T05:31:56Z",
  "is_autopilot_enabled": false
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
module_id
integer
required

Response

Successful Response

Schema for reading PlanModule.

​
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
​
constraint
integer
required
​
analysis_frequency_hours
integer
required
​
id
integer
required
​
date_added
string<date-time>
required
​
date_updated
string<date-time>
required
​
is_autopilot_enabled
boolean
default:false