@zernio/node 0.2.863 → 0.2.865
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +147 -29
- package/dist/index.d.ts +147 -29
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +1 -0
- package/src/generated/types.gen.ts +147 -29
package/dist/index.d.mts
CHANGED
|
@@ -13572,6 +13572,10 @@ type GetYouTubeChannelInsightsData = {
|
|
|
13572
13572
|
* The Zernio SocialAccount ID for the YouTube account.
|
|
13573
13573
|
*/
|
|
13574
13574
|
accountId: string;
|
|
13575
|
+
/**
|
|
13576
|
+
* Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
13577
|
+
*/
|
|
13578
|
+
fromDate?: string;
|
|
13575
13579
|
/**
|
|
13576
13580
|
* Comma-separated list. Defaults to "views,estimatedMinutesWatched,subscribersGained,subscribersLost".
|
|
13577
13581
|
*
|
|
@@ -13595,7 +13599,8 @@ type GetYouTubeChannelInsightsData = {
|
|
|
13595
13599
|
*/
|
|
13596
13600
|
metricType?: 'time_series' | 'total_value';
|
|
13597
13601
|
/**
|
|
13598
|
-
*
|
|
13602
|
+
* Alias of fromDate, kept for existing callers
|
|
13603
|
+
* @deprecated
|
|
13599
13604
|
*/
|
|
13600
13605
|
since?: string;
|
|
13601
13606
|
/**
|
|
@@ -13605,6 +13610,11 @@ type GetYouTubeChannelInsightsData = {
|
|
|
13605
13610
|
* field reflects your requested value.
|
|
13606
13611
|
*
|
|
13607
13612
|
*/
|
|
13613
|
+
toDate?: string;
|
|
13614
|
+
/**
|
|
13615
|
+
* Alias of toDate, kept for existing callers
|
|
13616
|
+
* @deprecated
|
|
13617
|
+
*/
|
|
13608
13618
|
until?: string;
|
|
13609
13619
|
};
|
|
13610
13620
|
};
|
|
@@ -13618,6 +13628,10 @@ type GetLinkedInOrgAggregateAnalyticsData = {
|
|
|
13618
13628
|
* The Zernio SocialAccount ID for the LinkedIn organization account.
|
|
13619
13629
|
*/
|
|
13620
13630
|
accountId: string;
|
|
13631
|
+
/**
|
|
13632
|
+
* Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
13633
|
+
*/
|
|
13634
|
+
fromDate?: string;
|
|
13621
13635
|
/**
|
|
13622
13636
|
* Comma-separated list. Defaults to
|
|
13623
13637
|
* "impressions,clicks,engagement_rate,organic_followers_gained,followers_gained,followers_lost".
|
|
@@ -13650,12 +13664,18 @@ type GetLinkedInOrgAggregateAnalyticsData = {
|
|
|
13650
13664
|
metrics?: string;
|
|
13651
13665
|
metricType?: 'time_series' | 'total_value';
|
|
13652
13666
|
/**
|
|
13653
|
-
*
|
|
13667
|
+
* Alias of fromDate, kept for existing callers
|
|
13668
|
+
* @deprecated
|
|
13654
13669
|
*/
|
|
13655
13670
|
since?: string;
|
|
13656
13671
|
/**
|
|
13657
13672
|
* End date (YYYY-MM-DD). Defaults to today.
|
|
13658
13673
|
*/
|
|
13674
|
+
toDate?: string;
|
|
13675
|
+
/**
|
|
13676
|
+
* Alias of toDate, kept for existing callers
|
|
13677
|
+
* @deprecated
|
|
13678
|
+
*/
|
|
13659
13679
|
until?: string;
|
|
13660
13680
|
};
|
|
13661
13681
|
};
|
|
@@ -13669,6 +13689,10 @@ type GetTikTokAccountInsightsData = {
|
|
|
13669
13689
|
* The Zernio SocialAccount ID for the TikTok account.
|
|
13670
13690
|
*/
|
|
13671
13691
|
accountId: string;
|
|
13692
|
+
/**
|
|
13693
|
+
* Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
13694
|
+
*/
|
|
13695
|
+
fromDate?: string;
|
|
13672
13696
|
/**
|
|
13673
13697
|
* Comma-separated list. Defaults to
|
|
13674
13698
|
* "follower_count,likes_count,video_count,followers_gained,followers_lost".
|
|
@@ -13692,12 +13716,18 @@ type GetTikTokAccountInsightsData = {
|
|
|
13692
13716
|
*/
|
|
13693
13717
|
metricType?: 'time_series' | 'total_value';
|
|
13694
13718
|
/**
|
|
13695
|
-
*
|
|
13719
|
+
* Alias of fromDate, kept for existing callers
|
|
13720
|
+
* @deprecated
|
|
13696
13721
|
*/
|
|
13697
13722
|
since?: string;
|
|
13698
13723
|
/**
|
|
13699
13724
|
* End date (YYYY-MM-DD). Defaults to today.
|
|
13700
13725
|
*/
|
|
13726
|
+
toDate?: string;
|
|
13727
|
+
/**
|
|
13728
|
+
* Alias of toDate, kept for existing callers
|
|
13729
|
+
* @deprecated
|
|
13730
|
+
*/
|
|
13701
13731
|
until?: string;
|
|
13702
13732
|
};
|
|
13703
13733
|
};
|
|
@@ -13712,18 +13742,28 @@ type GetYouTubeDailyViewsData = {
|
|
|
13712
13742
|
*/
|
|
13713
13743
|
accountId: string;
|
|
13714
13744
|
/**
|
|
13715
|
-
*
|
|
13716
|
-
*
|
|
13717
|
-
* up to today: days inside the delay window are provisional and may still be revised
|
|
13718
|
-
* by YouTube (see provisionalSince in the response), and days YouTube has not
|
|
13719
|
-
* processed yet are omitted from dailyViews.
|
|
13720
|
-
*
|
|
13745
|
+
* Alias of toDate, kept for existing callers
|
|
13746
|
+
* @deprecated
|
|
13721
13747
|
*/
|
|
13722
13748
|
endDate?: string;
|
|
13723
13749
|
/**
|
|
13724
13750
|
* Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
13725
13751
|
*/
|
|
13752
|
+
fromDate?: string;
|
|
13753
|
+
/**
|
|
13754
|
+
* Alias of fromDate, kept for existing callers
|
|
13755
|
+
* @deprecated
|
|
13756
|
+
*/
|
|
13726
13757
|
startDate?: string;
|
|
13758
|
+
/**
|
|
13759
|
+
* End date (YYYY-MM-DD). Defaults to 3 days ago, the newest fully finalized day
|
|
13760
|
+
* (YouTube finalizes analytics with a ~3-day delay). An explicit toDate is honored
|
|
13761
|
+
* up to today: days inside the delay window are provisional and may still be revised
|
|
13762
|
+
* by YouTube (see provisionalSince in the response), and days YouTube has not
|
|
13763
|
+
* processed yet are omitted from dailyViews.
|
|
13764
|
+
*
|
|
13765
|
+
*/
|
|
13766
|
+
toDate?: string;
|
|
13727
13767
|
/**
|
|
13728
13768
|
* The YouTube video ID (e.g., "dQw4w9WgXcQ")
|
|
13729
13769
|
*/
|
|
@@ -13747,17 +13787,27 @@ type GetYouTubeVideoRetentionData = {
|
|
|
13747
13787
|
*/
|
|
13748
13788
|
accountId: string;
|
|
13749
13789
|
/**
|
|
13750
|
-
*
|
|
13751
|
-
*
|
|
13752
|
-
* up to today: days inside the delay window are provisional and may still be revised
|
|
13753
|
-
* by YouTube (see provisionalSince in the response).
|
|
13754
|
-
*
|
|
13790
|
+
* Alias of toDate, kept for existing callers
|
|
13791
|
+
* @deprecated
|
|
13755
13792
|
*/
|
|
13756
13793
|
endDate?: string;
|
|
13757
13794
|
/**
|
|
13758
13795
|
* Start date (YYYY-MM-DD). Defaults to the video's publish date (lifetime curve).
|
|
13759
13796
|
*/
|
|
13797
|
+
fromDate?: string;
|
|
13798
|
+
/**
|
|
13799
|
+
* Alias of fromDate, kept for existing callers
|
|
13800
|
+
* @deprecated
|
|
13801
|
+
*/
|
|
13760
13802
|
startDate?: string;
|
|
13803
|
+
/**
|
|
13804
|
+
* End date (YYYY-MM-DD). Defaults to 3 days ago, the newest fully finalized day
|
|
13805
|
+
* (YouTube finalizes analytics with a ~3-day delay). An explicit toDate is honored
|
|
13806
|
+
* up to today: days inside the delay window are provisional and may still be revised
|
|
13807
|
+
* by YouTube (see provisionalSince in the response).
|
|
13808
|
+
*
|
|
13809
|
+
*/
|
|
13810
|
+
toDate?: string;
|
|
13761
13811
|
/**
|
|
13762
13812
|
* The YouTube video ID (e.g., "dQw4w9WgXcQ")
|
|
13763
13813
|
*/
|
|
@@ -13785,6 +13835,10 @@ type GetFacebookPageInsightsData = {
|
|
|
13785
13835
|
* The Zernio SocialAccount ID for the connected Facebook Page.
|
|
13786
13836
|
*/
|
|
13787
13837
|
accountId: string;
|
|
13838
|
+
/**
|
|
13839
|
+
* Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
13840
|
+
*/
|
|
13841
|
+
fromDate?: string;
|
|
13788
13842
|
/**
|
|
13789
13843
|
* Comma-separated list of metrics. Defaults to
|
|
13790
13844
|
* "page_media_view,page_post_engagements,page_follows,followers_gained,followers_lost".
|
|
@@ -13836,12 +13890,18 @@ type GetFacebookPageInsightsData = {
|
|
|
13836
13890
|
*/
|
|
13837
13891
|
metricType?: 'time_series' | 'total_value';
|
|
13838
13892
|
/**
|
|
13839
|
-
*
|
|
13893
|
+
* Alias of fromDate, kept for existing callers
|
|
13894
|
+
* @deprecated
|
|
13840
13895
|
*/
|
|
13841
13896
|
since?: string;
|
|
13842
13897
|
/**
|
|
13843
13898
|
* End date (YYYY-MM-DD). Defaults to today.
|
|
13844
13899
|
*/
|
|
13900
|
+
toDate?: string;
|
|
13901
|
+
/**
|
|
13902
|
+
* Alias of toDate, kept for existing callers
|
|
13903
|
+
* @deprecated
|
|
13904
|
+
*/
|
|
13845
13905
|
until?: string;
|
|
13846
13906
|
};
|
|
13847
13907
|
};
|
|
@@ -13891,6 +13951,10 @@ type GetInstagramAccountInsightsData = {
|
|
|
13891
13951
|
*
|
|
13892
13952
|
*/
|
|
13893
13953
|
breakdown?: string;
|
|
13954
|
+
/**
|
|
13955
|
+
* Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
13956
|
+
*/
|
|
13957
|
+
fromDate?: string;
|
|
13894
13958
|
/**
|
|
13895
13959
|
* Comma-separated list of metrics. Defaults to "reach,views,accounts_engaged,total_interactions".
|
|
13896
13960
|
* Valid metrics: reach, views, accounts_engaged, total_interactions, comments, likes, saves, shares,
|
|
@@ -13909,12 +13973,18 @@ type GetInstagramAccountInsightsData = {
|
|
|
13909
13973
|
*/
|
|
13910
13974
|
metricType?: 'time_series' | 'total_value';
|
|
13911
13975
|
/**
|
|
13912
|
-
*
|
|
13976
|
+
* Alias of fromDate, kept for existing callers
|
|
13977
|
+
* @deprecated
|
|
13913
13978
|
*/
|
|
13914
13979
|
since?: string;
|
|
13915
13980
|
/**
|
|
13916
13981
|
* End date (YYYY-MM-DD). Defaults to today.
|
|
13917
13982
|
*/
|
|
13983
|
+
toDate?: string;
|
|
13984
|
+
/**
|
|
13985
|
+
* Alias of toDate, kept for existing callers
|
|
13986
|
+
* @deprecated
|
|
13987
|
+
*/
|
|
13918
13988
|
until?: string;
|
|
13919
13989
|
};
|
|
13920
13990
|
};
|
|
@@ -13931,6 +14001,10 @@ type GetInstagramFollowerHistoryData = {
|
|
|
13931
14001
|
* The Zernio SocialAccount ID for the Instagram account.
|
|
13932
14002
|
*/
|
|
13933
14003
|
accountId: string;
|
|
14004
|
+
/**
|
|
14005
|
+
* Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
14006
|
+
*/
|
|
14007
|
+
fromDate?: string;
|
|
13934
14008
|
/**
|
|
13935
14009
|
* Comma-separated list. Defaults to "follower_count,followers_gained,followers_lost".
|
|
13936
14010
|
* - follower_count : per-day raw follower count
|
|
@@ -13946,12 +14020,18 @@ type GetInstagramFollowerHistoryData = {
|
|
|
13946
14020
|
*/
|
|
13947
14021
|
metricType?: 'time_series' | 'total_value';
|
|
13948
14022
|
/**
|
|
13949
|
-
*
|
|
14023
|
+
* Alias of fromDate, kept for existing callers
|
|
14024
|
+
* @deprecated
|
|
13950
14025
|
*/
|
|
13951
14026
|
since?: string;
|
|
13952
14027
|
/**
|
|
13953
14028
|
* End date (YYYY-MM-DD). Defaults to today.
|
|
13954
14029
|
*/
|
|
14030
|
+
toDate?: string;
|
|
14031
|
+
/**
|
|
14032
|
+
* Alias of toDate, kept for existing callers
|
|
14033
|
+
* @deprecated
|
|
14034
|
+
*/
|
|
13955
14035
|
until?: string;
|
|
13956
14036
|
};
|
|
13957
14037
|
};
|
|
@@ -14003,11 +14083,8 @@ type GetYouTubeDemographicsData = {
|
|
|
14003
14083
|
*/
|
|
14004
14084
|
breakdown?: string;
|
|
14005
14085
|
/**
|
|
14006
|
-
*
|
|
14007
|
-
*
|
|
14008
|
-
* up to today: days inside the delay window are provisional and may still be revised
|
|
14009
|
-
* by YouTube (see provisionalSince in the response).
|
|
14010
|
-
*
|
|
14086
|
+
* Alias of toDate, kept for existing callers
|
|
14087
|
+
* @deprecated
|
|
14011
14088
|
*/
|
|
14012
14089
|
endDate?: string;
|
|
14013
14090
|
/**
|
|
@@ -14015,7 +14092,20 @@ type GetYouTubeDemographicsData = {
|
|
|
14015
14092
|
* publish date (lifetime) when videoId is provided.
|
|
14016
14093
|
*
|
|
14017
14094
|
*/
|
|
14095
|
+
fromDate?: string;
|
|
14096
|
+
/**
|
|
14097
|
+
* Alias of fromDate, kept for existing callers
|
|
14098
|
+
* @deprecated
|
|
14099
|
+
*/
|
|
14018
14100
|
startDate?: string;
|
|
14101
|
+
/**
|
|
14102
|
+
* End date (YYYY-MM-DD). Defaults to 3 days ago, the newest fully finalized day
|
|
14103
|
+
* (YouTube finalizes analytics with a ~3-day delay). An explicit toDate is honored
|
|
14104
|
+
* up to today: days inside the delay window are provisional and may still be revised
|
|
14105
|
+
* by YouTube (see provisionalSince in the response).
|
|
14106
|
+
*
|
|
14107
|
+
*/
|
|
14108
|
+
toDate?: string;
|
|
14019
14109
|
/**
|
|
14020
14110
|
* YouTube video ID. When provided, demographics are scoped to this single video
|
|
14021
14111
|
* (must belong to the connected channel; otherwise 404 video_not_found).
|
|
@@ -14367,9 +14457,14 @@ type GetGoogleBusinessPerformanceData = {
|
|
|
14367
14457
|
*/
|
|
14368
14458
|
accountId: string;
|
|
14369
14459
|
/**
|
|
14370
|
-
*
|
|
14460
|
+
* Alias of toDate, kept for existing callers
|
|
14461
|
+
* @deprecated
|
|
14371
14462
|
*/
|
|
14372
14463
|
endDate?: string;
|
|
14464
|
+
/**
|
|
14465
|
+
* Start date (YYYY-MM-DD). Defaults to 30 days ago. Max 18 months back.
|
|
14466
|
+
*/
|
|
14467
|
+
fromDate?: string;
|
|
14373
14468
|
/**
|
|
14374
14469
|
* Comma-separated metric names. Defaults to all available metrics.
|
|
14375
14470
|
* Valid values: BUSINESS_IMPRESSIONS_DESKTOP_MAPS, BUSINESS_IMPRESSIONS_DESKTOP_SEARCH,
|
|
@@ -14380,9 +14475,14 @@ type GetGoogleBusinessPerformanceData = {
|
|
|
14380
14475
|
*/
|
|
14381
14476
|
metrics?: string;
|
|
14382
14477
|
/**
|
|
14383
|
-
*
|
|
14478
|
+
* Alias of fromDate, kept for existing callers
|
|
14479
|
+
* @deprecated
|
|
14384
14480
|
*/
|
|
14385
14481
|
startDate?: string;
|
|
14482
|
+
/**
|
|
14483
|
+
* End date (YYYY-MM-DD). Defaults to today.
|
|
14484
|
+
*/
|
|
14485
|
+
toDate?: string;
|
|
14386
14486
|
};
|
|
14387
14487
|
};
|
|
14388
14488
|
type GetGoogleBusinessPerformanceResponse = ({
|
|
@@ -20169,24 +20269,38 @@ type GetLinkedInAggregateAnalyticsData = {
|
|
|
20169
20269
|
*/
|
|
20170
20270
|
aggregation?: 'TOTAL' | 'DAILY';
|
|
20171
20271
|
/**
|
|
20172
|
-
*
|
|
20272
|
+
* Alias of toDate, kept for existing callers
|
|
20273
|
+
* @deprecated
|
|
20173
20274
|
*/
|
|
20174
20275
|
endDate?: string;
|
|
20276
|
+
/**
|
|
20277
|
+
* Start date (YYYY-MM-DD). If omitted, returns lifetime analytics.
|
|
20278
|
+
*/
|
|
20279
|
+
fromDate?: string;
|
|
20175
20280
|
/**
|
|
20176
20281
|
* Comma-separated metrics: IMPRESSION, MEMBERS_REACHED, REACTION, COMMENT, RESHARE, POST_SAVE, POST_SEND. Omit for all.
|
|
20177
20282
|
*/
|
|
20178
20283
|
metrics?: string;
|
|
20179
20284
|
/**
|
|
20180
|
-
*
|
|
20285
|
+
* Alias of fromDate, kept for existing callers
|
|
20286
|
+
* @deprecated
|
|
20181
20287
|
*/
|
|
20182
20288
|
startDate?: string;
|
|
20289
|
+
/**
|
|
20290
|
+
* End date (YYYY-MM-DD, exclusive). Defaults to today if omitted.
|
|
20291
|
+
*/
|
|
20292
|
+
toDate?: string;
|
|
20183
20293
|
};
|
|
20184
20294
|
};
|
|
20185
20295
|
type GetLinkedInAggregateAnalyticsResponse = ((LinkedInAggregateAnalyticsTotalResponse | LinkedInAggregateAnalyticsDailyResponse));
|
|
20186
20296
|
type GetLinkedInAggregateAnalyticsError = ({
|
|
20187
20297
|
error?: string;
|
|
20188
20298
|
code?: string;
|
|
20189
|
-
|
|
20299
|
+
/**
|
|
20300
|
+
* The query parameter at fault on a validation failure
|
|
20301
|
+
*/
|
|
20302
|
+
param?: string;
|
|
20303
|
+
type?: string;
|
|
20190
20304
|
} | {
|
|
20191
20305
|
error?: string;
|
|
20192
20306
|
} | {
|
|
@@ -42926,9 +43040,13 @@ type SendWhatsAppConversionError = (unknown | {
|
|
|
42926
43040
|
type CreateMessagingAdData = {
|
|
42927
43041
|
body: (CtwaAdRequestBody & {
|
|
42928
43042
|
/**
|
|
42929
|
-
* Where the conversation opens when the ad is tapped.
|
|
43043
|
+
* Where the conversation opens when the ad is tapped. Set this OR `destinations`, not both.
|
|
43044
|
+
*/
|
|
43045
|
+
destination?: 'whatsapp' | 'messenger' | 'instagram_direct';
|
|
43046
|
+
/**
|
|
43047
|
+
* Two or three messaging apps on ONE ad set, like Ads Manager's "all messaging apps": the ad set gets Meta's combined destination_type (e.g. MESSAGING_INSTAGRAM_DIRECT_MESSENGER_WHATSAPP) and the creative one CTA per app, so Meta opens the app each viewer is likeliest to answer from. WhatsApp in the list still needs the Page paired with a WhatsApp Business number. With `adSetId`, the existing ad set must already use that combined destination_type. Set this OR `destination`, not both.
|
|
42930
43048
|
*/
|
|
42931
|
-
|
|
43049
|
+
destinations?: Array<('whatsapp' | 'messenger' | 'instagram_direct')>;
|
|
42932
43050
|
});
|
|
42933
43051
|
};
|
|
42934
43052
|
type CreateMessagingAdResponse = ((CtwaSingleResponse | CtwaMultiResponse));
|
package/dist/index.d.ts
CHANGED
|
@@ -13572,6 +13572,10 @@ type GetYouTubeChannelInsightsData = {
|
|
|
13572
13572
|
* The Zernio SocialAccount ID for the YouTube account.
|
|
13573
13573
|
*/
|
|
13574
13574
|
accountId: string;
|
|
13575
|
+
/**
|
|
13576
|
+
* Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
13577
|
+
*/
|
|
13578
|
+
fromDate?: string;
|
|
13575
13579
|
/**
|
|
13576
13580
|
* Comma-separated list. Defaults to "views,estimatedMinutesWatched,subscribersGained,subscribersLost".
|
|
13577
13581
|
*
|
|
@@ -13595,7 +13599,8 @@ type GetYouTubeChannelInsightsData = {
|
|
|
13595
13599
|
*/
|
|
13596
13600
|
metricType?: 'time_series' | 'total_value';
|
|
13597
13601
|
/**
|
|
13598
|
-
*
|
|
13602
|
+
* Alias of fromDate, kept for existing callers
|
|
13603
|
+
* @deprecated
|
|
13599
13604
|
*/
|
|
13600
13605
|
since?: string;
|
|
13601
13606
|
/**
|
|
@@ -13605,6 +13610,11 @@ type GetYouTubeChannelInsightsData = {
|
|
|
13605
13610
|
* field reflects your requested value.
|
|
13606
13611
|
*
|
|
13607
13612
|
*/
|
|
13613
|
+
toDate?: string;
|
|
13614
|
+
/**
|
|
13615
|
+
* Alias of toDate, kept for existing callers
|
|
13616
|
+
* @deprecated
|
|
13617
|
+
*/
|
|
13608
13618
|
until?: string;
|
|
13609
13619
|
};
|
|
13610
13620
|
};
|
|
@@ -13618,6 +13628,10 @@ type GetLinkedInOrgAggregateAnalyticsData = {
|
|
|
13618
13628
|
* The Zernio SocialAccount ID for the LinkedIn organization account.
|
|
13619
13629
|
*/
|
|
13620
13630
|
accountId: string;
|
|
13631
|
+
/**
|
|
13632
|
+
* Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
13633
|
+
*/
|
|
13634
|
+
fromDate?: string;
|
|
13621
13635
|
/**
|
|
13622
13636
|
* Comma-separated list. Defaults to
|
|
13623
13637
|
* "impressions,clicks,engagement_rate,organic_followers_gained,followers_gained,followers_lost".
|
|
@@ -13650,12 +13664,18 @@ type GetLinkedInOrgAggregateAnalyticsData = {
|
|
|
13650
13664
|
metrics?: string;
|
|
13651
13665
|
metricType?: 'time_series' | 'total_value';
|
|
13652
13666
|
/**
|
|
13653
|
-
*
|
|
13667
|
+
* Alias of fromDate, kept for existing callers
|
|
13668
|
+
* @deprecated
|
|
13654
13669
|
*/
|
|
13655
13670
|
since?: string;
|
|
13656
13671
|
/**
|
|
13657
13672
|
* End date (YYYY-MM-DD). Defaults to today.
|
|
13658
13673
|
*/
|
|
13674
|
+
toDate?: string;
|
|
13675
|
+
/**
|
|
13676
|
+
* Alias of toDate, kept for existing callers
|
|
13677
|
+
* @deprecated
|
|
13678
|
+
*/
|
|
13659
13679
|
until?: string;
|
|
13660
13680
|
};
|
|
13661
13681
|
};
|
|
@@ -13669,6 +13689,10 @@ type GetTikTokAccountInsightsData = {
|
|
|
13669
13689
|
* The Zernio SocialAccount ID for the TikTok account.
|
|
13670
13690
|
*/
|
|
13671
13691
|
accountId: string;
|
|
13692
|
+
/**
|
|
13693
|
+
* Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
13694
|
+
*/
|
|
13695
|
+
fromDate?: string;
|
|
13672
13696
|
/**
|
|
13673
13697
|
* Comma-separated list. Defaults to
|
|
13674
13698
|
* "follower_count,likes_count,video_count,followers_gained,followers_lost".
|
|
@@ -13692,12 +13716,18 @@ type GetTikTokAccountInsightsData = {
|
|
|
13692
13716
|
*/
|
|
13693
13717
|
metricType?: 'time_series' | 'total_value';
|
|
13694
13718
|
/**
|
|
13695
|
-
*
|
|
13719
|
+
* Alias of fromDate, kept for existing callers
|
|
13720
|
+
* @deprecated
|
|
13696
13721
|
*/
|
|
13697
13722
|
since?: string;
|
|
13698
13723
|
/**
|
|
13699
13724
|
* End date (YYYY-MM-DD). Defaults to today.
|
|
13700
13725
|
*/
|
|
13726
|
+
toDate?: string;
|
|
13727
|
+
/**
|
|
13728
|
+
* Alias of toDate, kept for existing callers
|
|
13729
|
+
* @deprecated
|
|
13730
|
+
*/
|
|
13701
13731
|
until?: string;
|
|
13702
13732
|
};
|
|
13703
13733
|
};
|
|
@@ -13712,18 +13742,28 @@ type GetYouTubeDailyViewsData = {
|
|
|
13712
13742
|
*/
|
|
13713
13743
|
accountId: string;
|
|
13714
13744
|
/**
|
|
13715
|
-
*
|
|
13716
|
-
*
|
|
13717
|
-
* up to today: days inside the delay window are provisional and may still be revised
|
|
13718
|
-
* by YouTube (see provisionalSince in the response), and days YouTube has not
|
|
13719
|
-
* processed yet are omitted from dailyViews.
|
|
13720
|
-
*
|
|
13745
|
+
* Alias of toDate, kept for existing callers
|
|
13746
|
+
* @deprecated
|
|
13721
13747
|
*/
|
|
13722
13748
|
endDate?: string;
|
|
13723
13749
|
/**
|
|
13724
13750
|
* Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
13725
13751
|
*/
|
|
13752
|
+
fromDate?: string;
|
|
13753
|
+
/**
|
|
13754
|
+
* Alias of fromDate, kept for existing callers
|
|
13755
|
+
* @deprecated
|
|
13756
|
+
*/
|
|
13726
13757
|
startDate?: string;
|
|
13758
|
+
/**
|
|
13759
|
+
* End date (YYYY-MM-DD). Defaults to 3 days ago, the newest fully finalized day
|
|
13760
|
+
* (YouTube finalizes analytics with a ~3-day delay). An explicit toDate is honored
|
|
13761
|
+
* up to today: days inside the delay window are provisional and may still be revised
|
|
13762
|
+
* by YouTube (see provisionalSince in the response), and days YouTube has not
|
|
13763
|
+
* processed yet are omitted from dailyViews.
|
|
13764
|
+
*
|
|
13765
|
+
*/
|
|
13766
|
+
toDate?: string;
|
|
13727
13767
|
/**
|
|
13728
13768
|
* The YouTube video ID (e.g., "dQw4w9WgXcQ")
|
|
13729
13769
|
*/
|
|
@@ -13747,17 +13787,27 @@ type GetYouTubeVideoRetentionData = {
|
|
|
13747
13787
|
*/
|
|
13748
13788
|
accountId: string;
|
|
13749
13789
|
/**
|
|
13750
|
-
*
|
|
13751
|
-
*
|
|
13752
|
-
* up to today: days inside the delay window are provisional and may still be revised
|
|
13753
|
-
* by YouTube (see provisionalSince in the response).
|
|
13754
|
-
*
|
|
13790
|
+
* Alias of toDate, kept for existing callers
|
|
13791
|
+
* @deprecated
|
|
13755
13792
|
*/
|
|
13756
13793
|
endDate?: string;
|
|
13757
13794
|
/**
|
|
13758
13795
|
* Start date (YYYY-MM-DD). Defaults to the video's publish date (lifetime curve).
|
|
13759
13796
|
*/
|
|
13797
|
+
fromDate?: string;
|
|
13798
|
+
/**
|
|
13799
|
+
* Alias of fromDate, kept for existing callers
|
|
13800
|
+
* @deprecated
|
|
13801
|
+
*/
|
|
13760
13802
|
startDate?: string;
|
|
13803
|
+
/**
|
|
13804
|
+
* End date (YYYY-MM-DD). Defaults to 3 days ago, the newest fully finalized day
|
|
13805
|
+
* (YouTube finalizes analytics with a ~3-day delay). An explicit toDate is honored
|
|
13806
|
+
* up to today: days inside the delay window are provisional and may still be revised
|
|
13807
|
+
* by YouTube (see provisionalSince in the response).
|
|
13808
|
+
*
|
|
13809
|
+
*/
|
|
13810
|
+
toDate?: string;
|
|
13761
13811
|
/**
|
|
13762
13812
|
* The YouTube video ID (e.g., "dQw4w9WgXcQ")
|
|
13763
13813
|
*/
|
|
@@ -13785,6 +13835,10 @@ type GetFacebookPageInsightsData = {
|
|
|
13785
13835
|
* The Zernio SocialAccount ID for the connected Facebook Page.
|
|
13786
13836
|
*/
|
|
13787
13837
|
accountId: string;
|
|
13838
|
+
/**
|
|
13839
|
+
* Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
13840
|
+
*/
|
|
13841
|
+
fromDate?: string;
|
|
13788
13842
|
/**
|
|
13789
13843
|
* Comma-separated list of metrics. Defaults to
|
|
13790
13844
|
* "page_media_view,page_post_engagements,page_follows,followers_gained,followers_lost".
|
|
@@ -13836,12 +13890,18 @@ type GetFacebookPageInsightsData = {
|
|
|
13836
13890
|
*/
|
|
13837
13891
|
metricType?: 'time_series' | 'total_value';
|
|
13838
13892
|
/**
|
|
13839
|
-
*
|
|
13893
|
+
* Alias of fromDate, kept for existing callers
|
|
13894
|
+
* @deprecated
|
|
13840
13895
|
*/
|
|
13841
13896
|
since?: string;
|
|
13842
13897
|
/**
|
|
13843
13898
|
* End date (YYYY-MM-DD). Defaults to today.
|
|
13844
13899
|
*/
|
|
13900
|
+
toDate?: string;
|
|
13901
|
+
/**
|
|
13902
|
+
* Alias of toDate, kept for existing callers
|
|
13903
|
+
* @deprecated
|
|
13904
|
+
*/
|
|
13845
13905
|
until?: string;
|
|
13846
13906
|
};
|
|
13847
13907
|
};
|
|
@@ -13891,6 +13951,10 @@ type GetInstagramAccountInsightsData = {
|
|
|
13891
13951
|
*
|
|
13892
13952
|
*/
|
|
13893
13953
|
breakdown?: string;
|
|
13954
|
+
/**
|
|
13955
|
+
* Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
13956
|
+
*/
|
|
13957
|
+
fromDate?: string;
|
|
13894
13958
|
/**
|
|
13895
13959
|
* Comma-separated list of metrics. Defaults to "reach,views,accounts_engaged,total_interactions".
|
|
13896
13960
|
* Valid metrics: reach, views, accounts_engaged, total_interactions, comments, likes, saves, shares,
|
|
@@ -13909,12 +13973,18 @@ type GetInstagramAccountInsightsData = {
|
|
|
13909
13973
|
*/
|
|
13910
13974
|
metricType?: 'time_series' | 'total_value';
|
|
13911
13975
|
/**
|
|
13912
|
-
*
|
|
13976
|
+
* Alias of fromDate, kept for existing callers
|
|
13977
|
+
* @deprecated
|
|
13913
13978
|
*/
|
|
13914
13979
|
since?: string;
|
|
13915
13980
|
/**
|
|
13916
13981
|
* End date (YYYY-MM-DD). Defaults to today.
|
|
13917
13982
|
*/
|
|
13983
|
+
toDate?: string;
|
|
13984
|
+
/**
|
|
13985
|
+
* Alias of toDate, kept for existing callers
|
|
13986
|
+
* @deprecated
|
|
13987
|
+
*/
|
|
13918
13988
|
until?: string;
|
|
13919
13989
|
};
|
|
13920
13990
|
};
|
|
@@ -13931,6 +14001,10 @@ type GetInstagramFollowerHistoryData = {
|
|
|
13931
14001
|
* The Zernio SocialAccount ID for the Instagram account.
|
|
13932
14002
|
*/
|
|
13933
14003
|
accountId: string;
|
|
14004
|
+
/**
|
|
14005
|
+
* Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
14006
|
+
*/
|
|
14007
|
+
fromDate?: string;
|
|
13934
14008
|
/**
|
|
13935
14009
|
* Comma-separated list. Defaults to "follower_count,followers_gained,followers_lost".
|
|
13936
14010
|
* - follower_count : per-day raw follower count
|
|
@@ -13946,12 +14020,18 @@ type GetInstagramFollowerHistoryData = {
|
|
|
13946
14020
|
*/
|
|
13947
14021
|
metricType?: 'time_series' | 'total_value';
|
|
13948
14022
|
/**
|
|
13949
|
-
*
|
|
14023
|
+
* Alias of fromDate, kept for existing callers
|
|
14024
|
+
* @deprecated
|
|
13950
14025
|
*/
|
|
13951
14026
|
since?: string;
|
|
13952
14027
|
/**
|
|
13953
14028
|
* End date (YYYY-MM-DD). Defaults to today.
|
|
13954
14029
|
*/
|
|
14030
|
+
toDate?: string;
|
|
14031
|
+
/**
|
|
14032
|
+
* Alias of toDate, kept for existing callers
|
|
14033
|
+
* @deprecated
|
|
14034
|
+
*/
|
|
13955
14035
|
until?: string;
|
|
13956
14036
|
};
|
|
13957
14037
|
};
|
|
@@ -14003,11 +14083,8 @@ type GetYouTubeDemographicsData = {
|
|
|
14003
14083
|
*/
|
|
14004
14084
|
breakdown?: string;
|
|
14005
14085
|
/**
|
|
14006
|
-
*
|
|
14007
|
-
*
|
|
14008
|
-
* up to today: days inside the delay window are provisional and may still be revised
|
|
14009
|
-
* by YouTube (see provisionalSince in the response).
|
|
14010
|
-
*
|
|
14086
|
+
* Alias of toDate, kept for existing callers
|
|
14087
|
+
* @deprecated
|
|
14011
14088
|
*/
|
|
14012
14089
|
endDate?: string;
|
|
14013
14090
|
/**
|
|
@@ -14015,7 +14092,20 @@ type GetYouTubeDemographicsData = {
|
|
|
14015
14092
|
* publish date (lifetime) when videoId is provided.
|
|
14016
14093
|
*
|
|
14017
14094
|
*/
|
|
14095
|
+
fromDate?: string;
|
|
14096
|
+
/**
|
|
14097
|
+
* Alias of fromDate, kept for existing callers
|
|
14098
|
+
* @deprecated
|
|
14099
|
+
*/
|
|
14018
14100
|
startDate?: string;
|
|
14101
|
+
/**
|
|
14102
|
+
* End date (YYYY-MM-DD). Defaults to 3 days ago, the newest fully finalized day
|
|
14103
|
+
* (YouTube finalizes analytics with a ~3-day delay). An explicit toDate is honored
|
|
14104
|
+
* up to today: days inside the delay window are provisional and may still be revised
|
|
14105
|
+
* by YouTube (see provisionalSince in the response).
|
|
14106
|
+
*
|
|
14107
|
+
*/
|
|
14108
|
+
toDate?: string;
|
|
14019
14109
|
/**
|
|
14020
14110
|
* YouTube video ID. When provided, demographics are scoped to this single video
|
|
14021
14111
|
* (must belong to the connected channel; otherwise 404 video_not_found).
|
|
@@ -14367,9 +14457,14 @@ type GetGoogleBusinessPerformanceData = {
|
|
|
14367
14457
|
*/
|
|
14368
14458
|
accountId: string;
|
|
14369
14459
|
/**
|
|
14370
|
-
*
|
|
14460
|
+
* Alias of toDate, kept for existing callers
|
|
14461
|
+
* @deprecated
|
|
14371
14462
|
*/
|
|
14372
14463
|
endDate?: string;
|
|
14464
|
+
/**
|
|
14465
|
+
* Start date (YYYY-MM-DD). Defaults to 30 days ago. Max 18 months back.
|
|
14466
|
+
*/
|
|
14467
|
+
fromDate?: string;
|
|
14373
14468
|
/**
|
|
14374
14469
|
* Comma-separated metric names. Defaults to all available metrics.
|
|
14375
14470
|
* Valid values: BUSINESS_IMPRESSIONS_DESKTOP_MAPS, BUSINESS_IMPRESSIONS_DESKTOP_SEARCH,
|
|
@@ -14380,9 +14475,14 @@ type GetGoogleBusinessPerformanceData = {
|
|
|
14380
14475
|
*/
|
|
14381
14476
|
metrics?: string;
|
|
14382
14477
|
/**
|
|
14383
|
-
*
|
|
14478
|
+
* Alias of fromDate, kept for existing callers
|
|
14479
|
+
* @deprecated
|
|
14384
14480
|
*/
|
|
14385
14481
|
startDate?: string;
|
|
14482
|
+
/**
|
|
14483
|
+
* End date (YYYY-MM-DD). Defaults to today.
|
|
14484
|
+
*/
|
|
14485
|
+
toDate?: string;
|
|
14386
14486
|
};
|
|
14387
14487
|
};
|
|
14388
14488
|
type GetGoogleBusinessPerformanceResponse = ({
|
|
@@ -20169,24 +20269,38 @@ type GetLinkedInAggregateAnalyticsData = {
|
|
|
20169
20269
|
*/
|
|
20170
20270
|
aggregation?: 'TOTAL' | 'DAILY';
|
|
20171
20271
|
/**
|
|
20172
|
-
*
|
|
20272
|
+
* Alias of toDate, kept for existing callers
|
|
20273
|
+
* @deprecated
|
|
20173
20274
|
*/
|
|
20174
20275
|
endDate?: string;
|
|
20276
|
+
/**
|
|
20277
|
+
* Start date (YYYY-MM-DD). If omitted, returns lifetime analytics.
|
|
20278
|
+
*/
|
|
20279
|
+
fromDate?: string;
|
|
20175
20280
|
/**
|
|
20176
20281
|
* Comma-separated metrics: IMPRESSION, MEMBERS_REACHED, REACTION, COMMENT, RESHARE, POST_SAVE, POST_SEND. Omit for all.
|
|
20177
20282
|
*/
|
|
20178
20283
|
metrics?: string;
|
|
20179
20284
|
/**
|
|
20180
|
-
*
|
|
20285
|
+
* Alias of fromDate, kept for existing callers
|
|
20286
|
+
* @deprecated
|
|
20181
20287
|
*/
|
|
20182
20288
|
startDate?: string;
|
|
20289
|
+
/**
|
|
20290
|
+
* End date (YYYY-MM-DD, exclusive). Defaults to today if omitted.
|
|
20291
|
+
*/
|
|
20292
|
+
toDate?: string;
|
|
20183
20293
|
};
|
|
20184
20294
|
};
|
|
20185
20295
|
type GetLinkedInAggregateAnalyticsResponse = ((LinkedInAggregateAnalyticsTotalResponse | LinkedInAggregateAnalyticsDailyResponse));
|
|
20186
20296
|
type GetLinkedInAggregateAnalyticsError = ({
|
|
20187
20297
|
error?: string;
|
|
20188
20298
|
code?: string;
|
|
20189
|
-
|
|
20299
|
+
/**
|
|
20300
|
+
* The query parameter at fault on a validation failure
|
|
20301
|
+
*/
|
|
20302
|
+
param?: string;
|
|
20303
|
+
type?: string;
|
|
20190
20304
|
} | {
|
|
20191
20305
|
error?: string;
|
|
20192
20306
|
} | {
|
|
@@ -42926,9 +43040,13 @@ type SendWhatsAppConversionError = (unknown | {
|
|
|
42926
43040
|
type CreateMessagingAdData = {
|
|
42927
43041
|
body: (CtwaAdRequestBody & {
|
|
42928
43042
|
/**
|
|
42929
|
-
* Where the conversation opens when the ad is tapped.
|
|
43043
|
+
* Where the conversation opens when the ad is tapped. Set this OR `destinations`, not both.
|
|
43044
|
+
*/
|
|
43045
|
+
destination?: 'whatsapp' | 'messenger' | 'instagram_direct';
|
|
43046
|
+
/**
|
|
43047
|
+
* Two or three messaging apps on ONE ad set, like Ads Manager's "all messaging apps": the ad set gets Meta's combined destination_type (e.g. MESSAGING_INSTAGRAM_DIRECT_MESSENGER_WHATSAPP) and the creative one CTA per app, so Meta opens the app each viewer is likeliest to answer from. WhatsApp in the list still needs the Page paired with a WhatsApp Business number. With `adSetId`, the existing ad set must already use that combined destination_type. Set this OR `destination`, not both.
|
|
42930
43048
|
*/
|
|
42931
|
-
|
|
43049
|
+
destinations?: Array<('whatsapp' | 'messenger' | 'instagram_direct')>;
|
|
42932
43050
|
});
|
|
42933
43051
|
};
|
|
42934
43052
|
type CreateMessagingAdResponse = ((CtwaSingleResponse | CtwaMultiResponse));
|
package/dist/index.js
CHANGED
|
@@ -36,7 +36,7 @@ module.exports = __toCommonJS(index_exports);
|
|
|
36
36
|
// package.json
|
|
37
37
|
var package_default = {
|
|
38
38
|
name: "@zernio/node",
|
|
39
|
-
version: "0.2.
|
|
39
|
+
version: "0.2.865",
|
|
40
40
|
description: "The official Node.js library for the Zernio API",
|
|
41
41
|
main: "dist/index.js",
|
|
42
42
|
module: "dist/index.mjs",
|
package/dist/index.mjs
CHANGED
|
@@ -5,7 +5,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
|
|
|
5
5
|
// package.json
|
|
6
6
|
var package_default = {
|
|
7
7
|
name: "@zernio/node",
|
|
8
|
-
version: "0.2.
|
|
8
|
+
version: "0.2.865",
|
|
9
9
|
description: "The official Node.js library for the Zernio API",
|
|
10
10
|
main: "dist/index.js",
|
|
11
11
|
module: "dist/index.mjs",
|
package/package.json
CHANGED
package/src/generated/sdk.gen.ts
CHANGED
|
@@ -11743,6 +11743,7 @@ export const sendWhatsAppConversion = <ThrowOnError extends boolean = false>(opt
|
|
|
11743
11743
|
* Create messaging ad
|
|
11744
11744
|
* Creates a click-to-message ad; `destination` selects where the tapped ad opens a
|
|
11745
11745
|
* conversation: WhatsApp, the Page's Messenger inbox or the linked Instagram account's Direct inbox.
|
|
11746
|
+
* `destinations` puts two or three of them on one ad set and lets Meta pick the app per viewer.
|
|
11746
11747
|
* The ad set is created with the matching destination_type and
|
|
11747
11748
|
* CONVERSATIONS optimization; the campaign objective defaults to OUTCOME_ENGAGEMENT.
|
|
11748
11749
|
* Supports single-creative and multi-creative shapes. Supersedes POST /v1/ads/ctwa
|
|
@@ -12391,6 +12391,10 @@ export type GetYouTubeChannelInsightsData = {
|
|
|
12391
12391
|
* The Zernio SocialAccount ID for the YouTube account.
|
|
12392
12392
|
*/
|
|
12393
12393
|
accountId: string;
|
|
12394
|
+
/**
|
|
12395
|
+
* Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
12396
|
+
*/
|
|
12397
|
+
fromDate?: string;
|
|
12394
12398
|
/**
|
|
12395
12399
|
* Comma-separated list. Defaults to "views,estimatedMinutesWatched,subscribersGained,subscribersLost".
|
|
12396
12400
|
*
|
|
@@ -12414,7 +12418,8 @@ export type GetYouTubeChannelInsightsData = {
|
|
|
12414
12418
|
*/
|
|
12415
12419
|
metricType?: 'time_series' | 'total_value';
|
|
12416
12420
|
/**
|
|
12417
|
-
*
|
|
12421
|
+
* Alias of fromDate, kept for existing callers
|
|
12422
|
+
* @deprecated
|
|
12418
12423
|
*/
|
|
12419
12424
|
since?: string;
|
|
12420
12425
|
/**
|
|
@@ -12424,6 +12429,11 @@ export type GetYouTubeChannelInsightsData = {
|
|
|
12424
12429
|
* field reflects your requested value.
|
|
12425
12430
|
*
|
|
12426
12431
|
*/
|
|
12432
|
+
toDate?: string;
|
|
12433
|
+
/**
|
|
12434
|
+
* Alias of toDate, kept for existing callers
|
|
12435
|
+
* @deprecated
|
|
12436
|
+
*/
|
|
12427
12437
|
until?: string;
|
|
12428
12438
|
};
|
|
12429
12439
|
};
|
|
@@ -12440,6 +12450,10 @@ export type GetLinkedInOrgAggregateAnalyticsData = {
|
|
|
12440
12450
|
* The Zernio SocialAccount ID for the LinkedIn organization account.
|
|
12441
12451
|
*/
|
|
12442
12452
|
accountId: string;
|
|
12453
|
+
/**
|
|
12454
|
+
* Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
12455
|
+
*/
|
|
12456
|
+
fromDate?: string;
|
|
12443
12457
|
/**
|
|
12444
12458
|
* Comma-separated list. Defaults to
|
|
12445
12459
|
* "impressions,clicks,engagement_rate,organic_followers_gained,followers_gained,followers_lost".
|
|
@@ -12472,12 +12486,18 @@ export type GetLinkedInOrgAggregateAnalyticsData = {
|
|
|
12472
12486
|
metrics?: string;
|
|
12473
12487
|
metricType?: 'time_series' | 'total_value';
|
|
12474
12488
|
/**
|
|
12475
|
-
*
|
|
12489
|
+
* Alias of fromDate, kept for existing callers
|
|
12490
|
+
* @deprecated
|
|
12476
12491
|
*/
|
|
12477
12492
|
since?: string;
|
|
12478
12493
|
/**
|
|
12479
12494
|
* End date (YYYY-MM-DD). Defaults to today.
|
|
12480
12495
|
*/
|
|
12496
|
+
toDate?: string;
|
|
12497
|
+
/**
|
|
12498
|
+
* Alias of toDate, kept for existing callers
|
|
12499
|
+
* @deprecated
|
|
12500
|
+
*/
|
|
12481
12501
|
until?: string;
|
|
12482
12502
|
};
|
|
12483
12503
|
};
|
|
@@ -12494,6 +12514,10 @@ export type GetTikTokAccountInsightsData = {
|
|
|
12494
12514
|
* The Zernio SocialAccount ID for the TikTok account.
|
|
12495
12515
|
*/
|
|
12496
12516
|
accountId: string;
|
|
12517
|
+
/**
|
|
12518
|
+
* Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
12519
|
+
*/
|
|
12520
|
+
fromDate?: string;
|
|
12497
12521
|
/**
|
|
12498
12522
|
* Comma-separated list. Defaults to
|
|
12499
12523
|
* "follower_count,likes_count,video_count,followers_gained,followers_lost".
|
|
@@ -12517,12 +12541,18 @@ export type GetTikTokAccountInsightsData = {
|
|
|
12517
12541
|
*/
|
|
12518
12542
|
metricType?: 'time_series' | 'total_value';
|
|
12519
12543
|
/**
|
|
12520
|
-
*
|
|
12544
|
+
* Alias of fromDate, kept for existing callers
|
|
12545
|
+
* @deprecated
|
|
12521
12546
|
*/
|
|
12522
12547
|
since?: string;
|
|
12523
12548
|
/**
|
|
12524
12549
|
* End date (YYYY-MM-DD). Defaults to today.
|
|
12525
12550
|
*/
|
|
12551
|
+
toDate?: string;
|
|
12552
|
+
/**
|
|
12553
|
+
* Alias of toDate, kept for existing callers
|
|
12554
|
+
* @deprecated
|
|
12555
|
+
*/
|
|
12526
12556
|
until?: string;
|
|
12527
12557
|
};
|
|
12528
12558
|
};
|
|
@@ -12540,18 +12570,28 @@ export type GetYouTubeDailyViewsData = {
|
|
|
12540
12570
|
*/
|
|
12541
12571
|
accountId: string;
|
|
12542
12572
|
/**
|
|
12543
|
-
*
|
|
12544
|
-
*
|
|
12545
|
-
* up to today: days inside the delay window are provisional and may still be revised
|
|
12546
|
-
* by YouTube (see provisionalSince in the response), and days YouTube has not
|
|
12547
|
-
* processed yet are omitted from dailyViews.
|
|
12548
|
-
*
|
|
12573
|
+
* Alias of toDate, kept for existing callers
|
|
12574
|
+
* @deprecated
|
|
12549
12575
|
*/
|
|
12550
12576
|
endDate?: string;
|
|
12551
12577
|
/**
|
|
12552
12578
|
* Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
12553
12579
|
*/
|
|
12580
|
+
fromDate?: string;
|
|
12581
|
+
/**
|
|
12582
|
+
* Alias of fromDate, kept for existing callers
|
|
12583
|
+
* @deprecated
|
|
12584
|
+
*/
|
|
12554
12585
|
startDate?: string;
|
|
12586
|
+
/**
|
|
12587
|
+
* End date (YYYY-MM-DD). Defaults to 3 days ago, the newest fully finalized day
|
|
12588
|
+
* (YouTube finalizes analytics with a ~3-day delay). An explicit toDate is honored
|
|
12589
|
+
* up to today: days inside the delay window are provisional and may still be revised
|
|
12590
|
+
* by YouTube (see provisionalSince in the response), and days YouTube has not
|
|
12591
|
+
* processed yet are omitted from dailyViews.
|
|
12592
|
+
*
|
|
12593
|
+
*/
|
|
12594
|
+
toDate?: string;
|
|
12555
12595
|
/**
|
|
12556
12596
|
* The YouTube video ID (e.g., "dQw4w9WgXcQ")
|
|
12557
12597
|
*/
|
|
@@ -12578,17 +12618,27 @@ export type GetYouTubeVideoRetentionData = {
|
|
|
12578
12618
|
*/
|
|
12579
12619
|
accountId: string;
|
|
12580
12620
|
/**
|
|
12581
|
-
*
|
|
12582
|
-
*
|
|
12583
|
-
* up to today: days inside the delay window are provisional and may still be revised
|
|
12584
|
-
* by YouTube (see provisionalSince in the response).
|
|
12585
|
-
*
|
|
12621
|
+
* Alias of toDate, kept for existing callers
|
|
12622
|
+
* @deprecated
|
|
12586
12623
|
*/
|
|
12587
12624
|
endDate?: string;
|
|
12588
12625
|
/**
|
|
12589
12626
|
* Start date (YYYY-MM-DD). Defaults to the video's publish date (lifetime curve).
|
|
12590
12627
|
*/
|
|
12628
|
+
fromDate?: string;
|
|
12629
|
+
/**
|
|
12630
|
+
* Alias of fromDate, kept for existing callers
|
|
12631
|
+
* @deprecated
|
|
12632
|
+
*/
|
|
12591
12633
|
startDate?: string;
|
|
12634
|
+
/**
|
|
12635
|
+
* End date (YYYY-MM-DD). Defaults to 3 days ago, the newest fully finalized day
|
|
12636
|
+
* (YouTube finalizes analytics with a ~3-day delay). An explicit toDate is honored
|
|
12637
|
+
* up to today: days inside the delay window are provisional and may still be revised
|
|
12638
|
+
* by YouTube (see provisionalSince in the response).
|
|
12639
|
+
*
|
|
12640
|
+
*/
|
|
12641
|
+
toDate?: string;
|
|
12592
12642
|
/**
|
|
12593
12643
|
* The YouTube video ID (e.g., "dQw4w9WgXcQ")
|
|
12594
12644
|
*/
|
|
@@ -12619,6 +12669,10 @@ export type GetFacebookPageInsightsData = {
|
|
|
12619
12669
|
* The Zernio SocialAccount ID for the connected Facebook Page.
|
|
12620
12670
|
*/
|
|
12621
12671
|
accountId: string;
|
|
12672
|
+
/**
|
|
12673
|
+
* Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
12674
|
+
*/
|
|
12675
|
+
fromDate?: string;
|
|
12622
12676
|
/**
|
|
12623
12677
|
* Comma-separated list of metrics. Defaults to
|
|
12624
12678
|
* "page_media_view,page_post_engagements,page_follows,followers_gained,followers_lost".
|
|
@@ -12670,12 +12724,18 @@ export type GetFacebookPageInsightsData = {
|
|
|
12670
12724
|
*/
|
|
12671
12725
|
metricType?: 'time_series' | 'total_value';
|
|
12672
12726
|
/**
|
|
12673
|
-
*
|
|
12727
|
+
* Alias of fromDate, kept for existing callers
|
|
12728
|
+
* @deprecated
|
|
12674
12729
|
*/
|
|
12675
12730
|
since?: string;
|
|
12676
12731
|
/**
|
|
12677
12732
|
* End date (YYYY-MM-DD). Defaults to today.
|
|
12678
12733
|
*/
|
|
12734
|
+
toDate?: string;
|
|
12735
|
+
/**
|
|
12736
|
+
* Alias of toDate, kept for existing callers
|
|
12737
|
+
* @deprecated
|
|
12738
|
+
*/
|
|
12679
12739
|
until?: string;
|
|
12680
12740
|
};
|
|
12681
12741
|
};
|
|
@@ -12731,6 +12791,10 @@ export type GetInstagramAccountInsightsData = {
|
|
|
12731
12791
|
*
|
|
12732
12792
|
*/
|
|
12733
12793
|
breakdown?: string;
|
|
12794
|
+
/**
|
|
12795
|
+
* Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
12796
|
+
*/
|
|
12797
|
+
fromDate?: string;
|
|
12734
12798
|
/**
|
|
12735
12799
|
* Comma-separated list of metrics. Defaults to "reach,views,accounts_engaged,total_interactions".
|
|
12736
12800
|
* Valid metrics: reach, views, accounts_engaged, total_interactions, comments, likes, saves, shares,
|
|
@@ -12749,12 +12813,18 @@ export type GetInstagramAccountInsightsData = {
|
|
|
12749
12813
|
*/
|
|
12750
12814
|
metricType?: 'time_series' | 'total_value';
|
|
12751
12815
|
/**
|
|
12752
|
-
*
|
|
12816
|
+
* Alias of fromDate, kept for existing callers
|
|
12817
|
+
* @deprecated
|
|
12753
12818
|
*/
|
|
12754
12819
|
since?: string;
|
|
12755
12820
|
/**
|
|
12756
12821
|
* End date (YYYY-MM-DD). Defaults to today.
|
|
12757
12822
|
*/
|
|
12823
|
+
toDate?: string;
|
|
12824
|
+
/**
|
|
12825
|
+
* Alias of toDate, kept for existing callers
|
|
12826
|
+
* @deprecated
|
|
12827
|
+
*/
|
|
12758
12828
|
until?: string;
|
|
12759
12829
|
};
|
|
12760
12830
|
};
|
|
@@ -12774,6 +12844,10 @@ export type GetInstagramFollowerHistoryData = {
|
|
|
12774
12844
|
* The Zernio SocialAccount ID for the Instagram account.
|
|
12775
12845
|
*/
|
|
12776
12846
|
accountId: string;
|
|
12847
|
+
/**
|
|
12848
|
+
* Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
12849
|
+
*/
|
|
12850
|
+
fromDate?: string;
|
|
12777
12851
|
/**
|
|
12778
12852
|
* Comma-separated list. Defaults to "follower_count,followers_gained,followers_lost".
|
|
12779
12853
|
* - follower_count : per-day raw follower count
|
|
@@ -12789,12 +12863,18 @@ export type GetInstagramFollowerHistoryData = {
|
|
|
12789
12863
|
*/
|
|
12790
12864
|
metricType?: 'time_series' | 'total_value';
|
|
12791
12865
|
/**
|
|
12792
|
-
*
|
|
12866
|
+
* Alias of fromDate, kept for existing callers
|
|
12867
|
+
* @deprecated
|
|
12793
12868
|
*/
|
|
12794
12869
|
since?: string;
|
|
12795
12870
|
/**
|
|
12796
12871
|
* End date (YYYY-MM-DD). Defaults to today.
|
|
12797
12872
|
*/
|
|
12873
|
+
toDate?: string;
|
|
12874
|
+
/**
|
|
12875
|
+
* Alias of toDate, kept for existing callers
|
|
12876
|
+
* @deprecated
|
|
12877
|
+
*/
|
|
12798
12878
|
until?: string;
|
|
12799
12879
|
};
|
|
12800
12880
|
};
|
|
@@ -12852,11 +12932,8 @@ export type GetYouTubeDemographicsData = {
|
|
|
12852
12932
|
*/
|
|
12853
12933
|
breakdown?: string;
|
|
12854
12934
|
/**
|
|
12855
|
-
*
|
|
12856
|
-
*
|
|
12857
|
-
* up to today: days inside the delay window are provisional and may still be revised
|
|
12858
|
-
* by YouTube (see provisionalSince in the response).
|
|
12859
|
-
*
|
|
12935
|
+
* Alias of toDate, kept for existing callers
|
|
12936
|
+
* @deprecated
|
|
12860
12937
|
*/
|
|
12861
12938
|
endDate?: string;
|
|
12862
12939
|
/**
|
|
@@ -12864,7 +12941,20 @@ export type GetYouTubeDemographicsData = {
|
|
|
12864
12941
|
* publish date (lifetime) when videoId is provided.
|
|
12865
12942
|
*
|
|
12866
12943
|
*/
|
|
12944
|
+
fromDate?: string;
|
|
12945
|
+
/**
|
|
12946
|
+
* Alias of fromDate, kept for existing callers
|
|
12947
|
+
* @deprecated
|
|
12948
|
+
*/
|
|
12867
12949
|
startDate?: string;
|
|
12950
|
+
/**
|
|
12951
|
+
* End date (YYYY-MM-DD). Defaults to 3 days ago, the newest fully finalized day
|
|
12952
|
+
* (YouTube finalizes analytics with a ~3-day delay). An explicit toDate is honored
|
|
12953
|
+
* up to today: days inside the delay window are provisional and may still be revised
|
|
12954
|
+
* by YouTube (see provisionalSince in the response).
|
|
12955
|
+
*
|
|
12956
|
+
*/
|
|
12957
|
+
toDate?: string;
|
|
12868
12958
|
/**
|
|
12869
12959
|
* YouTube video ID. When provided, demographics are scoped to this single video
|
|
12870
12960
|
* (must belong to the connected channel; otherwise 404 video_not_found).
|
|
@@ -13234,9 +13324,14 @@ export type GetGoogleBusinessPerformanceData = {
|
|
|
13234
13324
|
*/
|
|
13235
13325
|
accountId: string;
|
|
13236
13326
|
/**
|
|
13237
|
-
*
|
|
13327
|
+
* Alias of toDate, kept for existing callers
|
|
13328
|
+
* @deprecated
|
|
13238
13329
|
*/
|
|
13239
13330
|
endDate?: string;
|
|
13331
|
+
/**
|
|
13332
|
+
* Start date (YYYY-MM-DD). Defaults to 30 days ago. Max 18 months back.
|
|
13333
|
+
*/
|
|
13334
|
+
fromDate?: string;
|
|
13240
13335
|
/**
|
|
13241
13336
|
* Comma-separated metric names. Defaults to all available metrics.
|
|
13242
13337
|
* Valid values: BUSINESS_IMPRESSIONS_DESKTOP_MAPS, BUSINESS_IMPRESSIONS_DESKTOP_SEARCH,
|
|
@@ -13247,9 +13342,14 @@ export type GetGoogleBusinessPerformanceData = {
|
|
|
13247
13342
|
*/
|
|
13248
13343
|
metrics?: string;
|
|
13249
13344
|
/**
|
|
13250
|
-
*
|
|
13345
|
+
* Alias of fromDate, kept for existing callers
|
|
13346
|
+
* @deprecated
|
|
13251
13347
|
*/
|
|
13252
13348
|
startDate?: string;
|
|
13349
|
+
/**
|
|
13350
|
+
* End date (YYYY-MM-DD). Defaults to today.
|
|
13351
|
+
*/
|
|
13352
|
+
toDate?: string;
|
|
13253
13353
|
};
|
|
13254
13354
|
};
|
|
13255
13355
|
|
|
@@ -19408,17 +19508,27 @@ export type GetLinkedInAggregateAnalyticsData = {
|
|
|
19408
19508
|
*/
|
|
19409
19509
|
aggregation?: 'TOTAL' | 'DAILY';
|
|
19410
19510
|
/**
|
|
19411
|
-
*
|
|
19511
|
+
* Alias of toDate, kept for existing callers
|
|
19512
|
+
* @deprecated
|
|
19412
19513
|
*/
|
|
19413
19514
|
endDate?: string;
|
|
19515
|
+
/**
|
|
19516
|
+
* Start date (YYYY-MM-DD). If omitted, returns lifetime analytics.
|
|
19517
|
+
*/
|
|
19518
|
+
fromDate?: string;
|
|
19414
19519
|
/**
|
|
19415
19520
|
* Comma-separated metrics: IMPRESSION, MEMBERS_REACHED, REACTION, COMMENT, RESHARE, POST_SAVE, POST_SEND. Omit for all.
|
|
19416
19521
|
*/
|
|
19417
19522
|
metrics?: string;
|
|
19418
19523
|
/**
|
|
19419
|
-
*
|
|
19524
|
+
* Alias of fromDate, kept for existing callers
|
|
19525
|
+
* @deprecated
|
|
19420
19526
|
*/
|
|
19421
19527
|
startDate?: string;
|
|
19528
|
+
/**
|
|
19529
|
+
* End date (YYYY-MM-DD, exclusive). Defaults to today if omitted.
|
|
19530
|
+
*/
|
|
19531
|
+
toDate?: string;
|
|
19422
19532
|
};
|
|
19423
19533
|
};
|
|
19424
19534
|
|
|
@@ -19427,7 +19537,11 @@ export type GetLinkedInAggregateAnalyticsResponse = ((LinkedInAggregateAnalytics
|
|
|
19427
19537
|
export type GetLinkedInAggregateAnalyticsError = ({
|
|
19428
19538
|
error?: string;
|
|
19429
19539
|
code?: string;
|
|
19430
|
-
|
|
19540
|
+
/**
|
|
19541
|
+
* The query parameter at fault on a validation failure
|
|
19542
|
+
*/
|
|
19543
|
+
param?: string;
|
|
19544
|
+
type?: string;
|
|
19431
19545
|
} | {
|
|
19432
19546
|
error?: string;
|
|
19433
19547
|
} | {
|
|
@@ -43760,9 +43874,13 @@ export type SendWhatsAppConversionError = (unknown | {
|
|
|
43760
43874
|
export type CreateMessagingAdData = {
|
|
43761
43875
|
body: (CtwaAdRequestBody & {
|
|
43762
43876
|
/**
|
|
43763
|
-
* Where the conversation opens when the ad is tapped.
|
|
43877
|
+
* Where the conversation opens when the ad is tapped. Set this OR `destinations`, not both.
|
|
43878
|
+
*/
|
|
43879
|
+
destination?: 'whatsapp' | 'messenger' | 'instagram_direct';
|
|
43880
|
+
/**
|
|
43881
|
+
* Two or three messaging apps on ONE ad set, like Ads Manager's "all messaging apps": the ad set gets Meta's combined destination_type (e.g. MESSAGING_INSTAGRAM_DIRECT_MESSENGER_WHATSAPP) and the creative one CTA per app, so Meta opens the app each viewer is likeliest to answer from. WhatsApp in the list still needs the Page paired with a WhatsApp Business number. With `adSetId`, the existing ad set must already use that combined destination_type. Set this OR `destination`, not both.
|
|
43764
43882
|
*/
|
|
43765
|
-
|
|
43883
|
+
destinations?: Array<('whatsapp' | 'messenger' | 'instagram_direct')>;
|
|
43766
43884
|
});
|
|
43767
43885
|
};
|
|
43768
43886
|
|