You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit af16c7a
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: openapi.yaml
+14-9Lines changed: 14 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -2984,6 +2984,7 @@ components:
2984
2984
createdAt: { type: string, format: date-time }
2985
2985
SocialAccount:
2986
2986
type: object
2987
+
required: [_id, platform, profileId, isActive]
2987
2988
properties:
2988
2989
_id: { type: string }
2989
2990
platform:
@@ -8580,6 +8581,7 @@ paths:
8580
8581
application/json:
8581
8582
schema:
8582
8583
type: object
8584
+
required: [accounts, hasAnalyticsAccess]
8583
8585
properties:
8584
8586
accounts:
8585
8587
type: array
@@ -19818,7 +19820,8 @@ paths:
19818
19820
description: |
19819
19821
Returns a paginated list of ads with metrics computed over an optional date range.
19820
19822
Use source=all to include externally-synced ads from platform ad managers.
19821
-
If no date range is provided, defaults to the last 90 days. Date range is capped at 90 days max.
19823
+
If no date range is provided, defaults to the last 90 days. Date range is capped at 730 days max.
19824
+
Ranges older than 90 days trigger a one-time on-demand fetch from the platform when scoped to a specific accountId, then serve from cache on subsequent requests.
19822
19825
security:
19823
19826
- bearerAuth: []
19824
19827
parameters:
@@ -19831,8 +19834,8 @@ paths:
19831
19834
- { name: adAccountId, in: query, schema: { type: string }, description: "Platform ad account ID (e.g. act_123 for Meta). Mirrors the same filter on /v1/ads/campaigns and /v1/ads/tree." }
- { name: campaignId, in: query, schema: { type: string }, description: Platform campaign ID (filter ads within a campaign) }
19834
-
- { name: fromDate, in: query, schema: { type: string, format: date }, description: "Start of metrics date range (YYYY-MM-DD). Defaults to 90 days ago." }
19835
-
- { name: toDate, in: query, schema: { type: string, format: date }, description: "End of metrics date range (YYYY-MM-DD). Defaults to today. Max 90-day range." }
19837
+
- { name: fromDate, in: query, schema: { type: string, format: date }, description: "Start of metrics date range (YYYY-MM-DD). Defaults to 90 days ago. Ranges older than 90 days trigger an on-demand platform fetch when scoped to a specific accountId." }
19838
+
- { name: toDate, in: query, schema: { type: string, format: date }, description: "End of metrics date range (YYYY-MM-DD). Defaults to today. Max 730-day range." }
19836
19839
responses:
19837
19840
'200':
19838
19841
description: Paginated ads
@@ -20271,7 +20274,8 @@ paths:
20271
20274
Metrics are computed over an optional date range, then rolled up from ad level to ad set
20272
20275
and campaign levels. Pagination is at the campaign level. Ads without a campaign or ad set
20273
20276
ID are grouped into synthetic "Ungrouped" buckets.
20274
-
If no date range is provided, defaults to the last 90 days. Date range is capped at 90 days max.
20277
+
If no date range is provided, defaults to the last 90 days. Date range is capped at 730 days max.
20278
+
Ranges older than 90 days trigger a one-time on-demand fetch from the platform when scoped to a specific accountId, then serve from cache on subsequent requests.
20275
20279
security:
20276
20280
- bearerAuth: []
20277
20281
parameters:
@@ -20283,8 +20287,8 @@ paths:
20283
20287
- { name: adAccountId, in: query, schema: { type: string }, description: Platform ad account ID }
20284
20288
- { name: accountId, in: query, schema: { type: string }, description: Social account ID }
- { name: fromDate, in: query, schema: { type: string, format: date }, description: "Start of metrics date range (YYYY-MM-DD). Defaults to 90 days ago." }
20287
-
- { name: toDate, in: query, schema: { type: string, format: date }, description: "End of metrics date range (YYYY-MM-DD). Defaults to today. Max 90-day range." }
20290
+
- { name: fromDate, in: query, schema: { type: string, format: date }, description: "Start of metrics date range (YYYY-MM-DD). Defaults to 90 days ago. Ranges older than 90 days trigger an on-demand platform fetch when scoped to a specific accountId." }
20291
+
- { name: toDate, in: query, schema: { type: string, format: date }, description: "End of metrics date range (YYYY-MM-DD). Defaults to today. Max 730-day range." }
20288
20292
responses:
20289
20293
'200':
20290
20294
description: Nested campaign tree with pagination
@@ -20434,13 +20438,14 @@ paths:
20434
20438
description: |
20435
20439
Returns detailed performance analytics for an ad. Includes summary metrics, a daily timeline
20436
20440
over the requested date range, and optional demographic breakdowns (Meta and TikTok only).
20437
-
If no date range is provided, defaults to the last 90 days. Date range is capped at 90 days max.
20441
+
If no date range is provided, defaults to the last 90 days. Date range is capped at 730 days max.
20442
+
Ranges older than 90 days trigger a one-time on-demand fetch from the platform, then serve from cache on subsequent requests.
- { name: fromDate, in: query, schema: { type: string, format: date }, description: "Start of date range (YYYY-MM-DD). Defaults to 90 days ago." }
20443
-
- { name: toDate, in: query, schema: { type: string, format: date }, description: "End of date range (YYYY-MM-DD). Defaults to today. Max 90-day range." }
20447
+
- { name: fromDate, in: query, schema: { type: string, format: date }, description: "Start of date range (YYYY-MM-DD). Defaults to 90 days ago. Ranges older than 90 days trigger an on-demand platform fetch." }
20448
+
- { name: toDate, in: query, schema: { type: string, format: date }, description: "End of date range (YYYY-MM-DD). Defaults to today. Max 730-day range." }
from_date: Start of metrics date range (YYYY-MM-DD). Defaults to 90 days ago.
1175
-
to_date: End of metrics date range (YYYY-MM-DD). Defaults to today. Max 90-day range."""
1174
+
from_date: Start of metrics date range (YYYY-MM-DD). Defaults to 90 days ago. Ranges older than 90 days trigger an on-demand platform fetch when scoped to a specific accountId.
1175
+
to_date: End of metrics date range (YYYY-MM-DD). Defaults to today. Max 730-day range."""
1176
1176
client=_get_client()
1177
1177
try:
1178
1178
response=client.ad_campaigns.get_ad_tree(
@@ -1219,8 +1219,8 @@ def ads_list_ads(
1219
1219
ad_account_id: Platform ad account ID (e.g. act_123 for Meta). Mirrors the same filter on /v1/ads/campaigns and /v1/ads/tree.
1220
1220
profile_id: Profile ID
1221
1221
campaign_id: Platform campaign ID (filter ads within a campaign)
1222
-
from_date: Start of metrics date range (YYYY-MM-DD). Defaults to 90 days ago.
1223
-
to_date: End of metrics date range (YYYY-MM-DD). Defaults to today. Max 90-day range."""
1222
+
from_date: Start of metrics date range (YYYY-MM-DD). Defaults to 90 days ago. Ranges older than 90 days trigger an on-demand platform fetch when scoped to a specific accountId.
1223
+
to_date: End of metrics date range (YYYY-MM-DD). Defaults to today. Max 730-day range."""
1224
1224
client=_get_client()
1225
1225
try:
1226
1226
response=client.ads.list_ads(
@@ -1313,8 +1313,8 @@ def ads_get_ad_analytics(
1313
1313
1314
1314
Args:
1315
1315
ad_id: (required)
1316
-
from_date: Start of date range (YYYY-MM-DD). Defaults to 90 days ago.
1317
-
to_date: End of date range (YYYY-MM-DD). Defaults to today. Max 90-day range.
1316
+
from_date: Start of date range (YYYY-MM-DD). Defaults to 90 days ago. Ranges older than 90 days trigger an on-demand platform fetch.
1317
+
to_date: End of date range (YYYY-MM-DD). Defaults to today. Max 730-day range.
0 commit comments