@wevion/cli 1.0.4429 → 1.0.4437
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/openapi.json +863 -4
- package/package.json +1 -1
package/openapi.json
CHANGED
|
@@ -14980,7 +14980,7 @@
|
|
|
14980
14980
|
"in": "query",
|
|
14981
14981
|
"name": "campaign_filters",
|
|
14982
14982
|
"required": false,
|
|
14983
|
-
"description": "JSON array of campaign filter groups, e.g. [{\"platform\":\"google\",\"mode\":\"exclude\",\"match\":\"all\",\"rules\":[{\"type\":\"text\",\"field\":\"campaign_name\",\"operator\":\"contains\",\"value\":\"[:V]\"}]}]. Each group targets one platform (optionally a subset of its ad_account_ids) and decides which of its campaigns enter the aggregation. Text rules match campaign_name / campaign_status / objective / bid_strategy / campaign_id; number rules match a metric aggregated PER CAMPAIGN over the requested range. Groups leave other platforms untouched."
|
|
14983
|
+
"description": "JSON array of campaign filter groups, e.g. [{\"platform\":\"google\",\"mode\":\"exclude\",\"match\":\"all\",\"rules\":[{\"type\":\"text\",\"field\":\"campaign_name\",\"operator\":\"contains\",\"value\":\"[:V]\"}]}]. Each group targets one platform (optionally a subset of its ad_account_ids) and decides which of its campaigns enter the aggregation. Text rules match campaign_name / campaign_status / objective / bid_strategy / campaign_id; number rules match a metric aggregated PER CAMPAIGN over the requested range; label rules (equals / not_equals) match the label the campaign carries for product, vertical, funnel or market (GET /api/v1/analytics/campaign-labels/values lists them). Groups leave other platforms untouched."
|
|
14984
14984
|
}
|
|
14985
14985
|
],
|
|
14986
14986
|
"security": [
|
|
@@ -15432,7 +15432,7 @@
|
|
|
15432
15432
|
"in": "query",
|
|
15433
15433
|
"name": "campaign_filters",
|
|
15434
15434
|
"required": false,
|
|
15435
|
-
"description": "JSON array of campaign filter groups, e.g. [{\"platform\":\"google\",\"mode\":\"exclude\",\"match\":\"all\",\"rules\":[{\"type\":\"text\",\"field\":\"campaign_name\",\"operator\":\"contains\",\"value\":\"[:V]\"}]}]. Each group targets one platform (optionally a subset of its ad_account_ids) and decides which of its campaigns enter the aggregation. Text rules match campaign_name / campaign_status / objective / bid_strategy / campaign_id; number rules match a metric aggregated PER CAMPAIGN over the requested range. Groups leave other platforms untouched."
|
|
15435
|
+
"description": "JSON array of campaign filter groups, e.g. [{\"platform\":\"google\",\"mode\":\"exclude\",\"match\":\"all\",\"rules\":[{\"type\":\"text\",\"field\":\"campaign_name\",\"operator\":\"contains\",\"value\":\"[:V]\"}]}]. Each group targets one platform (optionally a subset of its ad_account_ids) and decides which of its campaigns enter the aggregation. Text rules match campaign_name / campaign_status / objective / bid_strategy / campaign_id; number rules match a metric aggregated PER CAMPAIGN over the requested range; label rules (equals / not_equals) match the label the campaign carries for product, vertical, funnel or market (GET /api/v1/analytics/campaign-labels/values lists them). Groups leave other platforms untouched."
|
|
15436
15436
|
},
|
|
15437
15437
|
{
|
|
15438
15438
|
"schema": {
|
|
@@ -15911,7 +15911,7 @@
|
|
|
15911
15911
|
"in": "query",
|
|
15912
15912
|
"name": "campaign_filters",
|
|
15913
15913
|
"required": false,
|
|
15914
|
-
"description": "JSON array of campaign filter groups, e.g. [{\"platform\":\"google\",\"mode\":\"exclude\",\"match\":\"all\",\"rules\":[{\"type\":\"text\",\"field\":\"campaign_name\",\"operator\":\"contains\",\"value\":\"[:V]\"}]}]. Each group targets one platform (optionally a subset of its ad_account_ids) and decides which of its campaigns enter the aggregation. Text rules match campaign_name / campaign_status / objective / bid_strategy / campaign_id; number rules match a metric aggregated PER CAMPAIGN over the requested range. Groups leave other platforms untouched."
|
|
15914
|
+
"description": "JSON array of campaign filter groups, e.g. [{\"platform\":\"google\",\"mode\":\"exclude\",\"match\":\"all\",\"rules\":[{\"type\":\"text\",\"field\":\"campaign_name\",\"operator\":\"contains\",\"value\":\"[:V]\"}]}]. Each group targets one platform (optionally a subset of its ad_account_ids) and decides which of its campaigns enter the aggregation. Text rules match campaign_name / campaign_status / objective / bid_strategy / campaign_id; number rules match a metric aggregated PER CAMPAIGN over the requested range; label rules (equals / not_equals) match the label the campaign carries for product, vertical, funnel or market (GET /api/v1/analytics/campaign-labels/values lists them). Groups leave other platforms untouched."
|
|
15915
15915
|
},
|
|
15916
15916
|
{
|
|
15917
15917
|
"schema": {
|
|
@@ -16276,7 +16276,7 @@
|
|
|
16276
16276
|
"in": "query",
|
|
16277
16277
|
"name": "campaign_filters",
|
|
16278
16278
|
"required": false,
|
|
16279
|
-
"description": "JSON array of campaign filter groups, e.g. [{\"platform\":\"google\",\"mode\":\"exclude\",\"match\":\"all\",\"rules\":[{\"type\":\"text\",\"field\":\"campaign_name\",\"operator\":\"contains\",\"value\":\"[:V]\"}]}]. Each group targets one platform (optionally a subset of its ad_account_ids) and decides which of its campaigns enter the aggregation. Text rules match campaign_name / campaign_status / objective / bid_strategy / campaign_id; number rules match a metric aggregated PER CAMPAIGN over the requested range. Groups leave other platforms untouched."
|
|
16279
|
+
"description": "JSON array of campaign filter groups, e.g. [{\"platform\":\"google\",\"mode\":\"exclude\",\"match\":\"all\",\"rules\":[{\"type\":\"text\",\"field\":\"campaign_name\",\"operator\":\"contains\",\"value\":\"[:V]\"}]}]. Each group targets one platform (optionally a subset of its ad_account_ids) and decides which of its campaigns enter the aggregation. Text rules match campaign_name / campaign_status / objective / bid_strategy / campaign_id; number rules match a metric aggregated PER CAMPAIGN over the requested range; label rules (equals / not_equals) match the label the campaign carries for product, vertical, funnel or market (GET /api/v1/analytics/campaign-labels/values lists them). Groups leave other platforms untouched."
|
|
16280
16280
|
}
|
|
16281
16281
|
],
|
|
16282
16282
|
"security": [
|
|
@@ -74593,6 +74593,865 @@
|
|
|
74593
74593
|
}
|
|
74594
74594
|
}
|
|
74595
74595
|
},
|
|
74596
|
+
"/api/v1/analytics/campaign-labels/values": {
|
|
74597
|
+
"get": {
|
|
74598
|
+
"operationId": "getApiV1AnalyticsCampaignLabelsValues",
|
|
74599
|
+
"summary": "List the campaign label values in use",
|
|
74600
|
+
"tags": [
|
|
74601
|
+
"analytics"
|
|
74602
|
+
],
|
|
74603
|
+
"description": "Every label value the campaigns of the workspace carry, per platform and dimension, with how many campaigns carry it. These are the values the `label` rules of `campaign_filters` (/analytics/ad-metrics and the other ADV endpoints) can match. 503 FEATURE_DISABLED while the feature is off for the caller.",
|
|
74604
|
+
"parameters": [
|
|
74605
|
+
{
|
|
74606
|
+
"schema": {
|
|
74607
|
+
"format": "uuid",
|
|
74608
|
+
"type": "string"
|
|
74609
|
+
},
|
|
74610
|
+
"in": "header",
|
|
74611
|
+
"name": "x-team-id",
|
|
74612
|
+
"required": false,
|
|
74613
|
+
"description": "Destination workspace team id."
|
|
74614
|
+
}
|
|
74615
|
+
],
|
|
74616
|
+
"security": [
|
|
74617
|
+
{
|
|
74618
|
+
"bearerAuth": []
|
|
74619
|
+
}
|
|
74620
|
+
],
|
|
74621
|
+
"responses": {
|
|
74622
|
+
"200": {
|
|
74623
|
+
"description": "Successful response",
|
|
74624
|
+
"content": {
|
|
74625
|
+
"application/json": {
|
|
74626
|
+
"schema": {
|
|
74627
|
+
"additionalProperties": false,
|
|
74628
|
+
"type": "object",
|
|
74629
|
+
"required": [
|
|
74630
|
+
"values"
|
|
74631
|
+
],
|
|
74632
|
+
"properties": {
|
|
74633
|
+
"values": {
|
|
74634
|
+
"type": "array",
|
|
74635
|
+
"items": {
|
|
74636
|
+
"additionalProperties": false,
|
|
74637
|
+
"type": "object",
|
|
74638
|
+
"required": [
|
|
74639
|
+
"platform",
|
|
74640
|
+
"dimension",
|
|
74641
|
+
"value",
|
|
74642
|
+
"campaigns"
|
|
74643
|
+
],
|
|
74644
|
+
"properties": {
|
|
74645
|
+
"platform": {
|
|
74646
|
+
"type": "string"
|
|
74647
|
+
},
|
|
74648
|
+
"dimension": {
|
|
74649
|
+
"type": "string"
|
|
74650
|
+
},
|
|
74651
|
+
"value": {
|
|
74652
|
+
"type": "string"
|
|
74653
|
+
},
|
|
74654
|
+
"campaigns": {
|
|
74655
|
+
"minimum": 0,
|
|
74656
|
+
"type": "integer"
|
|
74657
|
+
}
|
|
74658
|
+
}
|
|
74659
|
+
}
|
|
74660
|
+
}
|
|
74661
|
+
}
|
|
74662
|
+
}
|
|
74663
|
+
}
|
|
74664
|
+
}
|
|
74665
|
+
},
|
|
74666
|
+
"400": {
|
|
74667
|
+
"description": "Explicit destination workspace required: send the x-team-id header or activate a team scope for this operation.",
|
|
74668
|
+
"content": {
|
|
74669
|
+
"application/json": {
|
|
74670
|
+
"schema": {
|
|
74671
|
+
"description": "Explicit destination workspace required: send the x-team-id header or activate a team scope for this operation.",
|
|
74672
|
+
"additionalProperties": false,
|
|
74673
|
+
"type": "object",
|
|
74674
|
+
"required": [
|
|
74675
|
+
"statusCode",
|
|
74676
|
+
"error",
|
|
74677
|
+
"message"
|
|
74678
|
+
],
|
|
74679
|
+
"properties": {
|
|
74680
|
+
"statusCode": {
|
|
74681
|
+
"type": "number"
|
|
74682
|
+
},
|
|
74683
|
+
"error": {
|
|
74684
|
+
"type": "string"
|
|
74685
|
+
},
|
|
74686
|
+
"message": {
|
|
74687
|
+
"type": "string"
|
|
74688
|
+
},
|
|
74689
|
+
"code": {
|
|
74690
|
+
"description": "`SCOPE_TEAM_REQUIRED` when no destination workspace was given; a validation 400 keeps its own code (e.g. `FST_ERR_VALIDATION`).",
|
|
74691
|
+
"type": "string"
|
|
74692
|
+
}
|
|
74693
|
+
}
|
|
74694
|
+
}
|
|
74695
|
+
}
|
|
74696
|
+
}
|
|
74697
|
+
},
|
|
74698
|
+
"401": {
|
|
74699
|
+
"description": "Unauthorized - missing or invalid bearer token",
|
|
74700
|
+
"content": {
|
|
74701
|
+
"application/json": {
|
|
74702
|
+
"schema": {
|
|
74703
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
74704
|
+
}
|
|
74705
|
+
}
|
|
74706
|
+
}
|
|
74707
|
+
},
|
|
74708
|
+
"503": {
|
|
74709
|
+
"description": "Campaign labels are off for the caller (runtime flag).",
|
|
74710
|
+
"content": {
|
|
74711
|
+
"application/json": {
|
|
74712
|
+
"schema": {
|
|
74713
|
+
"additionalProperties": false,
|
|
74714
|
+
"description": "Campaign labels are off for the caller (runtime flag).",
|
|
74715
|
+
"type": "object",
|
|
74716
|
+
"required": [
|
|
74717
|
+
"error",
|
|
74718
|
+
"code"
|
|
74719
|
+
],
|
|
74720
|
+
"properties": {
|
|
74721
|
+
"error": {
|
|
74722
|
+
"type": "string"
|
|
74723
|
+
},
|
|
74724
|
+
"code": {
|
|
74725
|
+
"type": "string",
|
|
74726
|
+
"enum": [
|
|
74727
|
+
"FEATURE_DISABLED"
|
|
74728
|
+
]
|
|
74729
|
+
}
|
|
74730
|
+
}
|
|
74731
|
+
}
|
|
74732
|
+
}
|
|
74733
|
+
}
|
|
74734
|
+
}
|
|
74735
|
+
}
|
|
74736
|
+
}
|
|
74737
|
+
},
|
|
74738
|
+
"/api/v1/analytics/campaign-labels": {
|
|
74739
|
+
"get": {
|
|
74740
|
+
"operationId": "getApiV1AnalyticsCampaignLabels",
|
|
74741
|
+
"summary": "List labelled campaigns",
|
|
74742
|
+
"tags": [
|
|
74743
|
+
"analytics"
|
|
74744
|
+
],
|
|
74745
|
+
"description": "The labelled campaigns of the workspace with their labels, ordered by name, paged and searchable by name or campaign id. Campaigns get labels when they spent in the last 30 days. 503 FEATURE_DISABLED while the feature is off for the caller.",
|
|
74746
|
+
"parameters": [
|
|
74747
|
+
{
|
|
74748
|
+
"schema": {
|
|
74749
|
+
"anyOf": [
|
|
74750
|
+
{
|
|
74751
|
+
"type": "string",
|
|
74752
|
+
"enum": [
|
|
74753
|
+
"meta"
|
|
74754
|
+
]
|
|
74755
|
+
},
|
|
74756
|
+
{
|
|
74757
|
+
"type": "string",
|
|
74758
|
+
"enum": [
|
|
74759
|
+
"google"
|
|
74760
|
+
]
|
|
74761
|
+
},
|
|
74762
|
+
{
|
|
74763
|
+
"type": "string",
|
|
74764
|
+
"enum": [
|
|
74765
|
+
"tiktok"
|
|
74766
|
+
]
|
|
74767
|
+
},
|
|
74768
|
+
{
|
|
74769
|
+
"type": "string",
|
|
74770
|
+
"enum": [
|
|
74771
|
+
"taboola"
|
|
74772
|
+
]
|
|
74773
|
+
},
|
|
74774
|
+
{
|
|
74775
|
+
"type": "string",
|
|
74776
|
+
"enum": [
|
|
74777
|
+
"snapchat"
|
|
74778
|
+
]
|
|
74779
|
+
},
|
|
74780
|
+
{
|
|
74781
|
+
"type": "string",
|
|
74782
|
+
"enum": [
|
|
74783
|
+
"outbrain"
|
|
74784
|
+
]
|
|
74785
|
+
},
|
|
74786
|
+
{
|
|
74787
|
+
"type": "string",
|
|
74788
|
+
"enum": [
|
|
74789
|
+
"exoclick"
|
|
74790
|
+
]
|
|
74791
|
+
}
|
|
74792
|
+
]
|
|
74793
|
+
},
|
|
74794
|
+
"in": "query",
|
|
74795
|
+
"name": "platform",
|
|
74796
|
+
"required": false,
|
|
74797
|
+
"description": "Ad platform of the campaign."
|
|
74798
|
+
},
|
|
74799
|
+
{
|
|
74800
|
+
"schema": {
|
|
74801
|
+
"maxLength": 100,
|
|
74802
|
+
"type": "string"
|
|
74803
|
+
},
|
|
74804
|
+
"in": "query",
|
|
74805
|
+
"name": "q",
|
|
74806
|
+
"required": false,
|
|
74807
|
+
"description": "Search in the campaign name or id."
|
|
74808
|
+
},
|
|
74809
|
+
{
|
|
74810
|
+
"schema": {
|
|
74811
|
+
"minimum": 1,
|
|
74812
|
+
"maximum": 100,
|
|
74813
|
+
"default": 50,
|
|
74814
|
+
"type": "integer"
|
|
74815
|
+
},
|
|
74816
|
+
"in": "query",
|
|
74817
|
+
"name": "limit",
|
|
74818
|
+
"required": false,
|
|
74819
|
+
"description": "Page size."
|
|
74820
|
+
},
|
|
74821
|
+
{
|
|
74822
|
+
"schema": {
|
|
74823
|
+
"minimum": 0,
|
|
74824
|
+
"maximum": 100000,
|
|
74825
|
+
"default": 0,
|
|
74826
|
+
"type": "integer"
|
|
74827
|
+
},
|
|
74828
|
+
"in": "query",
|
|
74829
|
+
"name": "offset",
|
|
74830
|
+
"required": false,
|
|
74831
|
+
"description": "Rows to skip."
|
|
74832
|
+
},
|
|
74833
|
+
{
|
|
74834
|
+
"schema": {
|
|
74835
|
+
"format": "uuid",
|
|
74836
|
+
"type": "string"
|
|
74837
|
+
},
|
|
74838
|
+
"in": "header",
|
|
74839
|
+
"name": "x-team-id",
|
|
74840
|
+
"required": false,
|
|
74841
|
+
"description": "Destination workspace team id."
|
|
74842
|
+
}
|
|
74843
|
+
],
|
|
74844
|
+
"security": [
|
|
74845
|
+
{
|
|
74846
|
+
"bearerAuth": []
|
|
74847
|
+
}
|
|
74848
|
+
],
|
|
74849
|
+
"responses": {
|
|
74850
|
+
"200": {
|
|
74851
|
+
"description": "Successful response",
|
|
74852
|
+
"content": {
|
|
74853
|
+
"application/json": {
|
|
74854
|
+
"schema": {
|
|
74855
|
+
"additionalProperties": false,
|
|
74856
|
+
"type": "object",
|
|
74857
|
+
"required": [
|
|
74858
|
+
"campaigns",
|
|
74859
|
+
"total"
|
|
74860
|
+
],
|
|
74861
|
+
"properties": {
|
|
74862
|
+
"campaigns": {
|
|
74863
|
+
"type": "array",
|
|
74864
|
+
"items": {
|
|
74865
|
+
"additionalProperties": false,
|
|
74866
|
+
"type": "object",
|
|
74867
|
+
"required": [
|
|
74868
|
+
"platform",
|
|
74869
|
+
"ad_account_id",
|
|
74870
|
+
"campaign_id",
|
|
74871
|
+
"campaign_name",
|
|
74872
|
+
"labels",
|
|
74873
|
+
"user_dimensions",
|
|
74874
|
+
"classified_at"
|
|
74875
|
+
],
|
|
74876
|
+
"properties": {
|
|
74877
|
+
"platform": {
|
|
74878
|
+
"type": "string"
|
|
74879
|
+
},
|
|
74880
|
+
"ad_account_id": {
|
|
74881
|
+
"type": "string"
|
|
74882
|
+
},
|
|
74883
|
+
"campaign_id": {
|
|
74884
|
+
"type": "string"
|
|
74885
|
+
},
|
|
74886
|
+
"campaign_name": {
|
|
74887
|
+
"description": "The name the labels were read from.",
|
|
74888
|
+
"anyOf": [
|
|
74889
|
+
{
|
|
74890
|
+
"type": "string"
|
|
74891
|
+
},
|
|
74892
|
+
{
|
|
74893
|
+
"type": "null"
|
|
74894
|
+
}
|
|
74895
|
+
]
|
|
74896
|
+
},
|
|
74897
|
+
"labels": {
|
|
74898
|
+
"additionalProperties": false,
|
|
74899
|
+
"description": "One value per dimension; a missing key means no label.",
|
|
74900
|
+
"type": "object",
|
|
74901
|
+
"properties": {
|
|
74902
|
+
"product": {
|
|
74903
|
+
"type": "string"
|
|
74904
|
+
},
|
|
74905
|
+
"vertical": {
|
|
74906
|
+
"type": "string"
|
|
74907
|
+
},
|
|
74908
|
+
"funnel": {
|
|
74909
|
+
"type": "string"
|
|
74910
|
+
},
|
|
74911
|
+
"market": {
|
|
74912
|
+
"type": "string"
|
|
74913
|
+
}
|
|
74914
|
+
}
|
|
74915
|
+
},
|
|
74916
|
+
"user_dimensions": {
|
|
74917
|
+
"description": "Dimensions set by a person. A new classification never changes them.",
|
|
74918
|
+
"type": "array",
|
|
74919
|
+
"items": {
|
|
74920
|
+
"type": "string"
|
|
74921
|
+
}
|
|
74922
|
+
},
|
|
74923
|
+
"classified_at": {
|
|
74924
|
+
"anyOf": [
|
|
74925
|
+
{
|
|
74926
|
+
"format": "date-time",
|
|
74927
|
+
"type": "string"
|
|
74928
|
+
},
|
|
74929
|
+
{
|
|
74930
|
+
"type": "null"
|
|
74931
|
+
}
|
|
74932
|
+
]
|
|
74933
|
+
}
|
|
74934
|
+
}
|
|
74935
|
+
}
|
|
74936
|
+
},
|
|
74937
|
+
"total": {
|
|
74938
|
+
"minimum": 0,
|
|
74939
|
+
"description": "All the campaigns the filters keep, across the pages.",
|
|
74940
|
+
"type": "integer"
|
|
74941
|
+
}
|
|
74942
|
+
}
|
|
74943
|
+
}
|
|
74944
|
+
}
|
|
74945
|
+
}
|
|
74946
|
+
},
|
|
74947
|
+
"400": {
|
|
74948
|
+
"description": "Explicit destination workspace required: send the x-team-id header or activate a team scope for this operation.",
|
|
74949
|
+
"content": {
|
|
74950
|
+
"application/json": {
|
|
74951
|
+
"schema": {
|
|
74952
|
+
"description": "Explicit destination workspace required: send the x-team-id header or activate a team scope for this operation.",
|
|
74953
|
+
"additionalProperties": false,
|
|
74954
|
+
"type": "object",
|
|
74955
|
+
"required": [
|
|
74956
|
+
"statusCode",
|
|
74957
|
+
"error",
|
|
74958
|
+
"message"
|
|
74959
|
+
],
|
|
74960
|
+
"properties": {
|
|
74961
|
+
"statusCode": {
|
|
74962
|
+
"type": "number"
|
|
74963
|
+
},
|
|
74964
|
+
"error": {
|
|
74965
|
+
"type": "string"
|
|
74966
|
+
},
|
|
74967
|
+
"message": {
|
|
74968
|
+
"type": "string"
|
|
74969
|
+
},
|
|
74970
|
+
"code": {
|
|
74971
|
+
"description": "`SCOPE_TEAM_REQUIRED` when no destination workspace was given; a validation 400 keeps its own code (e.g. `FST_ERR_VALIDATION`).",
|
|
74972
|
+
"type": "string"
|
|
74973
|
+
}
|
|
74974
|
+
}
|
|
74975
|
+
}
|
|
74976
|
+
}
|
|
74977
|
+
}
|
|
74978
|
+
},
|
|
74979
|
+
"401": {
|
|
74980
|
+
"description": "Unauthorized - missing or invalid bearer token",
|
|
74981
|
+
"content": {
|
|
74982
|
+
"application/json": {
|
|
74983
|
+
"schema": {
|
|
74984
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
74985
|
+
}
|
|
74986
|
+
}
|
|
74987
|
+
}
|
|
74988
|
+
},
|
|
74989
|
+
"503": {
|
|
74990
|
+
"description": "Campaign labels are off for the caller (runtime flag).",
|
|
74991
|
+
"content": {
|
|
74992
|
+
"application/json": {
|
|
74993
|
+
"schema": {
|
|
74994
|
+
"additionalProperties": false,
|
|
74995
|
+
"description": "Campaign labels are off for the caller (runtime flag).",
|
|
74996
|
+
"type": "object",
|
|
74997
|
+
"required": [
|
|
74998
|
+
"error",
|
|
74999
|
+
"code"
|
|
75000
|
+
],
|
|
75001
|
+
"properties": {
|
|
75002
|
+
"error": {
|
|
75003
|
+
"type": "string"
|
|
75004
|
+
},
|
|
75005
|
+
"code": {
|
|
75006
|
+
"type": "string",
|
|
75007
|
+
"enum": [
|
|
75008
|
+
"FEATURE_DISABLED"
|
|
75009
|
+
]
|
|
75010
|
+
}
|
|
75011
|
+
}
|
|
75012
|
+
}
|
|
75013
|
+
}
|
|
75014
|
+
}
|
|
75015
|
+
}
|
|
75016
|
+
}
|
|
75017
|
+
},
|
|
75018
|
+
"patch": {
|
|
75019
|
+
"operationId": "patchApiV1AnalyticsCampaignLabels",
|
|
75020
|
+
"summary": "Correct one label of a campaign",
|
|
75021
|
+
"tags": [
|
|
75022
|
+
"analytics"
|
|
75023
|
+
],
|
|
75024
|
+
"description": "Sets one dimension of a labelled campaign (null removes the label). The value is normalized like the proposed ones: `vertical` and `funnel` must be in their lists and `market` a country code or MULTI, otherwise the label is removed. A corrected dimension is never changed by a later classification, also when the campaign is renamed. 404 CAMPAIGN_LABEL_NOT_FOUND when the campaign has no labels in this workspace. 503 FEATURE_DISABLED while the feature is off for the caller.",
|
|
75025
|
+
"requestBody": {
|
|
75026
|
+
"required": true,
|
|
75027
|
+
"content": {
|
|
75028
|
+
"application/json": {
|
|
75029
|
+
"schema": {
|
|
75030
|
+
"additionalProperties": false,
|
|
75031
|
+
"type": "object",
|
|
75032
|
+
"required": [
|
|
75033
|
+
"platform",
|
|
75034
|
+
"ad_account_id",
|
|
75035
|
+
"campaign_id",
|
|
75036
|
+
"dimension",
|
|
75037
|
+
"value"
|
|
75038
|
+
],
|
|
75039
|
+
"properties": {
|
|
75040
|
+
"platform": {
|
|
75041
|
+
"description": "Ad platform of the campaign.",
|
|
75042
|
+
"anyOf": [
|
|
75043
|
+
{
|
|
75044
|
+
"type": "string",
|
|
75045
|
+
"enum": [
|
|
75046
|
+
"meta"
|
|
75047
|
+
]
|
|
75048
|
+
},
|
|
75049
|
+
{
|
|
75050
|
+
"type": "string",
|
|
75051
|
+
"enum": [
|
|
75052
|
+
"google"
|
|
75053
|
+
]
|
|
75054
|
+
},
|
|
75055
|
+
{
|
|
75056
|
+
"type": "string",
|
|
75057
|
+
"enum": [
|
|
75058
|
+
"tiktok"
|
|
75059
|
+
]
|
|
75060
|
+
},
|
|
75061
|
+
{
|
|
75062
|
+
"type": "string",
|
|
75063
|
+
"enum": [
|
|
75064
|
+
"taboola"
|
|
75065
|
+
]
|
|
75066
|
+
},
|
|
75067
|
+
{
|
|
75068
|
+
"type": "string",
|
|
75069
|
+
"enum": [
|
|
75070
|
+
"snapchat"
|
|
75071
|
+
]
|
|
75072
|
+
},
|
|
75073
|
+
{
|
|
75074
|
+
"type": "string",
|
|
75075
|
+
"enum": [
|
|
75076
|
+
"outbrain"
|
|
75077
|
+
]
|
|
75078
|
+
},
|
|
75079
|
+
{
|
|
75080
|
+
"type": "string",
|
|
75081
|
+
"enum": [
|
|
75082
|
+
"exoclick"
|
|
75083
|
+
]
|
|
75084
|
+
}
|
|
75085
|
+
]
|
|
75086
|
+
},
|
|
75087
|
+
"ad_account_id": {
|
|
75088
|
+
"minLength": 1,
|
|
75089
|
+
"maxLength": 50,
|
|
75090
|
+
"type": "string"
|
|
75091
|
+
},
|
|
75092
|
+
"campaign_id": {
|
|
75093
|
+
"minLength": 1,
|
|
75094
|
+
"maxLength": 50,
|
|
75095
|
+
"type": "string"
|
|
75096
|
+
},
|
|
75097
|
+
"dimension": {
|
|
75098
|
+
"description": "Label dimension: `product` (free text, the advertised product or offer), `vertical` (fixed list), `funnel` (prospecting, retargeting, retention), `market` (ISO 3166-1 alpha-2 country, or MULTI).",
|
|
75099
|
+
"anyOf": [
|
|
75100
|
+
{
|
|
75101
|
+
"type": "string",
|
|
75102
|
+
"enum": [
|
|
75103
|
+
"product"
|
|
75104
|
+
]
|
|
75105
|
+
},
|
|
75106
|
+
{
|
|
75107
|
+
"type": "string",
|
|
75108
|
+
"enum": [
|
|
75109
|
+
"vertical"
|
|
75110
|
+
]
|
|
75111
|
+
},
|
|
75112
|
+
{
|
|
75113
|
+
"type": "string",
|
|
75114
|
+
"enum": [
|
|
75115
|
+
"funnel"
|
|
75116
|
+
]
|
|
75117
|
+
},
|
|
75118
|
+
{
|
|
75119
|
+
"type": "string",
|
|
75120
|
+
"enum": [
|
|
75121
|
+
"market"
|
|
75122
|
+
]
|
|
75123
|
+
}
|
|
75124
|
+
]
|
|
75125
|
+
},
|
|
75126
|
+
"value": {
|
|
75127
|
+
"anyOf": [
|
|
75128
|
+
{
|
|
75129
|
+
"maxLength": 200,
|
|
75130
|
+
"type": "string"
|
|
75131
|
+
},
|
|
75132
|
+
{
|
|
75133
|
+
"type": "null"
|
|
75134
|
+
}
|
|
75135
|
+
]
|
|
75136
|
+
}
|
|
75137
|
+
}
|
|
75138
|
+
}
|
|
75139
|
+
}
|
|
75140
|
+
}
|
|
75141
|
+
},
|
|
75142
|
+
"parameters": [
|
|
75143
|
+
{
|
|
75144
|
+
"schema": {
|
|
75145
|
+
"format": "uuid",
|
|
75146
|
+
"type": "string"
|
|
75147
|
+
},
|
|
75148
|
+
"in": "header",
|
|
75149
|
+
"name": "x-team-id",
|
|
75150
|
+
"required": false,
|
|
75151
|
+
"description": "Destination workspace team id."
|
|
75152
|
+
}
|
|
75153
|
+
],
|
|
75154
|
+
"security": [
|
|
75155
|
+
{
|
|
75156
|
+
"bearerAuth": []
|
|
75157
|
+
}
|
|
75158
|
+
],
|
|
75159
|
+
"responses": {
|
|
75160
|
+
"200": {
|
|
75161
|
+
"description": "Successful response",
|
|
75162
|
+
"content": {
|
|
75163
|
+
"application/json": {
|
|
75164
|
+
"schema": {
|
|
75165
|
+
"additionalProperties": false,
|
|
75166
|
+
"type": "object",
|
|
75167
|
+
"required": [
|
|
75168
|
+
"platform",
|
|
75169
|
+
"ad_account_id",
|
|
75170
|
+
"campaign_id",
|
|
75171
|
+
"campaign_name",
|
|
75172
|
+
"labels",
|
|
75173
|
+
"user_dimensions",
|
|
75174
|
+
"classified_at"
|
|
75175
|
+
],
|
|
75176
|
+
"properties": {
|
|
75177
|
+
"platform": {
|
|
75178
|
+
"type": "string"
|
|
75179
|
+
},
|
|
75180
|
+
"ad_account_id": {
|
|
75181
|
+
"type": "string"
|
|
75182
|
+
},
|
|
75183
|
+
"campaign_id": {
|
|
75184
|
+
"type": "string"
|
|
75185
|
+
},
|
|
75186
|
+
"campaign_name": {
|
|
75187
|
+
"description": "The name the labels were read from.",
|
|
75188
|
+
"anyOf": [
|
|
75189
|
+
{
|
|
75190
|
+
"type": "string"
|
|
75191
|
+
},
|
|
75192
|
+
{
|
|
75193
|
+
"type": "null"
|
|
75194
|
+
}
|
|
75195
|
+
]
|
|
75196
|
+
},
|
|
75197
|
+
"labels": {
|
|
75198
|
+
"additionalProperties": false,
|
|
75199
|
+
"description": "One value per dimension; a missing key means no label.",
|
|
75200
|
+
"type": "object",
|
|
75201
|
+
"properties": {
|
|
75202
|
+
"product": {
|
|
75203
|
+
"type": "string"
|
|
75204
|
+
},
|
|
75205
|
+
"vertical": {
|
|
75206
|
+
"type": "string"
|
|
75207
|
+
},
|
|
75208
|
+
"funnel": {
|
|
75209
|
+
"type": "string"
|
|
75210
|
+
},
|
|
75211
|
+
"market": {
|
|
75212
|
+
"type": "string"
|
|
75213
|
+
}
|
|
75214
|
+
}
|
|
75215
|
+
},
|
|
75216
|
+
"user_dimensions": {
|
|
75217
|
+
"description": "Dimensions set by a person. A new classification never changes them.",
|
|
75218
|
+
"type": "array",
|
|
75219
|
+
"items": {
|
|
75220
|
+
"type": "string"
|
|
75221
|
+
}
|
|
75222
|
+
},
|
|
75223
|
+
"classified_at": {
|
|
75224
|
+
"anyOf": [
|
|
75225
|
+
{
|
|
75226
|
+
"format": "date-time",
|
|
75227
|
+
"type": "string"
|
|
75228
|
+
},
|
|
75229
|
+
{
|
|
75230
|
+
"type": "null"
|
|
75231
|
+
}
|
|
75232
|
+
]
|
|
75233
|
+
}
|
|
75234
|
+
}
|
|
75235
|
+
}
|
|
75236
|
+
}
|
|
75237
|
+
}
|
|
75238
|
+
},
|
|
75239
|
+
"400": {
|
|
75240
|
+
"description": "Explicit destination workspace required: send the x-team-id header or activate a team scope for this operation.",
|
|
75241
|
+
"content": {
|
|
75242
|
+
"application/json": {
|
|
75243
|
+
"schema": {
|
|
75244
|
+
"description": "Explicit destination workspace required: send the x-team-id header or activate a team scope for this operation.",
|
|
75245
|
+
"additionalProperties": false,
|
|
75246
|
+
"type": "object",
|
|
75247
|
+
"required": [
|
|
75248
|
+
"statusCode",
|
|
75249
|
+
"error",
|
|
75250
|
+
"message"
|
|
75251
|
+
],
|
|
75252
|
+
"properties": {
|
|
75253
|
+
"statusCode": {
|
|
75254
|
+
"type": "number"
|
|
75255
|
+
},
|
|
75256
|
+
"error": {
|
|
75257
|
+
"type": "string"
|
|
75258
|
+
},
|
|
75259
|
+
"message": {
|
|
75260
|
+
"type": "string"
|
|
75261
|
+
},
|
|
75262
|
+
"code": {
|
|
75263
|
+
"description": "`SCOPE_TEAM_REQUIRED` when no destination workspace was given; a validation 400 keeps its own code (e.g. `FST_ERR_VALIDATION`).",
|
|
75264
|
+
"type": "string"
|
|
75265
|
+
}
|
|
75266
|
+
}
|
|
75267
|
+
}
|
|
75268
|
+
}
|
|
75269
|
+
}
|
|
75270
|
+
},
|
|
75271
|
+
"401": {
|
|
75272
|
+
"description": "Unauthorized - missing or invalid bearer token",
|
|
75273
|
+
"content": {
|
|
75274
|
+
"application/json": {
|
|
75275
|
+
"schema": {
|
|
75276
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
75277
|
+
}
|
|
75278
|
+
}
|
|
75279
|
+
}
|
|
75280
|
+
},
|
|
75281
|
+
"404": {
|
|
75282
|
+
"description": "The campaign has no labels in this workspace yet.",
|
|
75283
|
+
"content": {
|
|
75284
|
+
"application/json": {
|
|
75285
|
+
"schema": {
|
|
75286
|
+
"additionalProperties": false,
|
|
75287
|
+
"description": "The campaign has no labels in this workspace yet.",
|
|
75288
|
+
"type": "object",
|
|
75289
|
+
"required": [
|
|
75290
|
+
"error",
|
|
75291
|
+
"code"
|
|
75292
|
+
],
|
|
75293
|
+
"properties": {
|
|
75294
|
+
"error": {
|
|
75295
|
+
"type": "string"
|
|
75296
|
+
},
|
|
75297
|
+
"code": {
|
|
75298
|
+
"type": "string",
|
|
75299
|
+
"enum": [
|
|
75300
|
+
"CAMPAIGN_LABEL_NOT_FOUND"
|
|
75301
|
+
]
|
|
75302
|
+
}
|
|
75303
|
+
}
|
|
75304
|
+
}
|
|
75305
|
+
}
|
|
75306
|
+
}
|
|
75307
|
+
},
|
|
75308
|
+
"503": {
|
|
75309
|
+
"description": "Campaign labels are off for the caller (runtime flag).",
|
|
75310
|
+
"content": {
|
|
75311
|
+
"application/json": {
|
|
75312
|
+
"schema": {
|
|
75313
|
+
"additionalProperties": false,
|
|
75314
|
+
"description": "Campaign labels are off for the caller (runtime flag).",
|
|
75315
|
+
"type": "object",
|
|
75316
|
+
"required": [
|
|
75317
|
+
"error",
|
|
75318
|
+
"code"
|
|
75319
|
+
],
|
|
75320
|
+
"properties": {
|
|
75321
|
+
"error": {
|
|
75322
|
+
"type": "string"
|
|
75323
|
+
},
|
|
75324
|
+
"code": {
|
|
75325
|
+
"type": "string",
|
|
75326
|
+
"enum": [
|
|
75327
|
+
"FEATURE_DISABLED"
|
|
75328
|
+
]
|
|
75329
|
+
}
|
|
75330
|
+
}
|
|
75331
|
+
}
|
|
75332
|
+
}
|
|
75333
|
+
}
|
|
75334
|
+
}
|
|
75335
|
+
}
|
|
75336
|
+
}
|
|
75337
|
+
},
|
|
75338
|
+
"/api/v1/analytics/campaign-labels/refresh": {
|
|
75339
|
+
"post": {
|
|
75340
|
+
"operationId": "postApiV1AnalyticsCampaignLabelsRefresh",
|
|
75341
|
+
"summary": "Label the new campaigns of the workspace",
|
|
75342
|
+
"tags": [
|
|
75343
|
+
"analytics"
|
|
75344
|
+
],
|
|
75345
|
+
"description": "Queues a classification run for the workspace: the campaigns that spent in the last 30 days and have no labels, or were renamed since, get them from the model, highest spend first, 200 per run: a run that fills the cap queues the next one by itself. At most one run every 30 minutes per workspace: `queued` is false when one was already queued in that window. The cost is paid by the platform. 503 FEATURE_DISABLED while the feature is off for the caller.",
|
|
75346
|
+
"parameters": [
|
|
75347
|
+
{
|
|
75348
|
+
"schema": {
|
|
75349
|
+
"format": "uuid",
|
|
75350
|
+
"type": "string"
|
|
75351
|
+
},
|
|
75352
|
+
"in": "header",
|
|
75353
|
+
"name": "x-team-id",
|
|
75354
|
+
"required": false,
|
|
75355
|
+
"description": "Destination workspace team id."
|
|
75356
|
+
}
|
|
75357
|
+
],
|
|
75358
|
+
"security": [
|
|
75359
|
+
{
|
|
75360
|
+
"bearerAuth": []
|
|
75361
|
+
}
|
|
75362
|
+
],
|
|
75363
|
+
"responses": {
|
|
75364
|
+
"202": {
|
|
75365
|
+
"description": "Accepted - processing asynchronously",
|
|
75366
|
+
"content": {
|
|
75367
|
+
"application/json": {
|
|
75368
|
+
"schema": {
|
|
75369
|
+
"additionalProperties": false,
|
|
75370
|
+
"type": "object",
|
|
75371
|
+
"required": [
|
|
75372
|
+
"queued"
|
|
75373
|
+
],
|
|
75374
|
+
"properties": {
|
|
75375
|
+
"queued": {
|
|
75376
|
+
"type": "boolean"
|
|
75377
|
+
}
|
|
75378
|
+
}
|
|
75379
|
+
}
|
|
75380
|
+
}
|
|
75381
|
+
}
|
|
75382
|
+
},
|
|
75383
|
+
"400": {
|
|
75384
|
+
"description": "Explicit destination workspace required: send the x-team-id header or activate a team scope for this operation.",
|
|
75385
|
+
"content": {
|
|
75386
|
+
"application/json": {
|
|
75387
|
+
"schema": {
|
|
75388
|
+
"description": "Explicit destination workspace required: send the x-team-id header or activate a team scope for this operation.",
|
|
75389
|
+
"additionalProperties": false,
|
|
75390
|
+
"type": "object",
|
|
75391
|
+
"required": [
|
|
75392
|
+
"statusCode",
|
|
75393
|
+
"error",
|
|
75394
|
+
"message"
|
|
75395
|
+
],
|
|
75396
|
+
"properties": {
|
|
75397
|
+
"statusCode": {
|
|
75398
|
+
"type": "number"
|
|
75399
|
+
},
|
|
75400
|
+
"error": {
|
|
75401
|
+
"type": "string"
|
|
75402
|
+
},
|
|
75403
|
+
"message": {
|
|
75404
|
+
"type": "string"
|
|
75405
|
+
},
|
|
75406
|
+
"code": {
|
|
75407
|
+
"description": "`SCOPE_TEAM_REQUIRED` when no destination workspace was given; a validation 400 keeps its own code (e.g. `FST_ERR_VALIDATION`).",
|
|
75408
|
+
"type": "string"
|
|
75409
|
+
}
|
|
75410
|
+
}
|
|
75411
|
+
}
|
|
75412
|
+
}
|
|
75413
|
+
}
|
|
75414
|
+
},
|
|
75415
|
+
"401": {
|
|
75416
|
+
"description": "Unauthorized - missing or invalid bearer token",
|
|
75417
|
+
"content": {
|
|
75418
|
+
"application/json": {
|
|
75419
|
+
"schema": {
|
|
75420
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
75421
|
+
}
|
|
75422
|
+
}
|
|
75423
|
+
}
|
|
75424
|
+
},
|
|
75425
|
+
"503": {
|
|
75426
|
+
"description": "Campaign labels are off for the caller (runtime flag).",
|
|
75427
|
+
"content": {
|
|
75428
|
+
"application/json": {
|
|
75429
|
+
"schema": {
|
|
75430
|
+
"additionalProperties": false,
|
|
75431
|
+
"description": "Campaign labels are off for the caller (runtime flag).",
|
|
75432
|
+
"type": "object",
|
|
75433
|
+
"required": [
|
|
75434
|
+
"error",
|
|
75435
|
+
"code"
|
|
75436
|
+
],
|
|
75437
|
+
"properties": {
|
|
75438
|
+
"error": {
|
|
75439
|
+
"type": "string"
|
|
75440
|
+
},
|
|
75441
|
+
"code": {
|
|
75442
|
+
"type": "string",
|
|
75443
|
+
"enum": [
|
|
75444
|
+
"FEATURE_DISABLED"
|
|
75445
|
+
]
|
|
75446
|
+
}
|
|
75447
|
+
}
|
|
75448
|
+
}
|
|
75449
|
+
}
|
|
75450
|
+
}
|
|
75451
|
+
}
|
|
75452
|
+
}
|
|
75453
|
+
}
|
|
75454
|
+
},
|
|
74596
75455
|
"/api/v1/campaign-templates": {
|
|
74597
75456
|
"get": {
|
|
74598
75457
|
"operationId": "listCampaignTemplates",
|