@wevion/cli 1.0.4704 → 1.0.4717
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 +2371 -233
- package/package.json +1 -1
package/openapi.json
CHANGED
|
@@ -54622,7 +54622,7 @@
|
|
|
54622
54622
|
"tags": [
|
|
54623
54623
|
"ad-agency"
|
|
54624
54624
|
],
|
|
54625
|
-
"description": "For an organization that arrived from an entry channel (today Adtucon): turns AD-Agency on for the destination workspace with the fixed fees of the channel and creates its empty STANDARD wallet in the chosen currency. Currency and platform are fixed from then on. Only owners and admins of the organization and managers of the workspace (403 `AD_AGENCY_FORBIDDEN`); any other organization is activated by its Wevion contact (403 `AD_AGENCY_SELF_SERVICE_UNAVAILABLE`). 409 `AD_AGENCY_SELF_SERVICE_FEES_NOT_SET` while the fees of the channel are not set, 409 `AD_AGENCY_SELF_SERVICE_PLATFORM` for a platform the client cannot activate alone
|
|
54625
|
+
"description": "For an organization that arrived from an entry channel (today Adtucon): turns AD-Agency on for the destination workspace with the fixed fees of the channel and creates its empty STANDARD wallet in the chosen currency. Currency and platform are fixed from then on. On a `tiktok` workspace Wevion also names its team in the TikTok delivery register of tiktok-spending-db: the workspace name followed by `_wevion`, plus a piece of the workspace id when another workspace already has that name. Only owners and admins of the organization and managers of the workspace (403 `AD_AGENCY_FORBIDDEN`); any other organization is activated by its Wevion contact (403 `AD_AGENCY_SELF_SERVICE_UNAVAILABLE`). 409 `AD_AGENCY_SELF_SERVICE_FEES_NOT_SET` while the fees of the channel are not set, 409 `AD_AGENCY_SELF_SERVICE_PLATFORM` for a platform the client cannot activate alone, 409 `AD_AGENCY_ALREADY_ACTIVATED` on a workspace that was activated before, 409 `AD_AGENCY_ALREADY_ACTIVE` when an activation from elsewhere won the race.",
|
|
54626
54626
|
"requestBody": {
|
|
54627
54627
|
"required": true,
|
|
54628
54628
|
"content": {
|
|
@@ -63721,6 +63721,1639 @@
|
|
|
63721
63721
|
}
|
|
63722
63722
|
}
|
|
63723
63723
|
},
|
|
63724
|
+
"/api/v1/analytics/campaign-filter-sets": {
|
|
63725
|
+
"get": {
|
|
63726
|
+
"operationId": "listAnalyticsCampaignFilterSets",
|
|
63727
|
+
"summary": "List the saved campaign filter sets",
|
|
63728
|
+
"tags": [
|
|
63729
|
+
"analytics"
|
|
63730
|
+
],
|
|
63731
|
+
"description": "The campaign filter sets saved in the workspace, ordered by name (at most 20). Each set carries its groups in the `campaign_filters` shape, ready to be sent again.",
|
|
63732
|
+
"parameters": [
|
|
63733
|
+
{
|
|
63734
|
+
"schema": {
|
|
63735
|
+
"format": "uuid",
|
|
63736
|
+
"type": "string"
|
|
63737
|
+
},
|
|
63738
|
+
"in": "header",
|
|
63739
|
+
"name": "x-team-id",
|
|
63740
|
+
"required": false,
|
|
63741
|
+
"description": "Destination workspace team id."
|
|
63742
|
+
}
|
|
63743
|
+
],
|
|
63744
|
+
"security": [
|
|
63745
|
+
{
|
|
63746
|
+
"bearerAuth": []
|
|
63747
|
+
}
|
|
63748
|
+
],
|
|
63749
|
+
"responses": {
|
|
63750
|
+
"200": {
|
|
63751
|
+
"description": "Successful response",
|
|
63752
|
+
"content": {
|
|
63753
|
+
"application/json": {
|
|
63754
|
+
"schema": {
|
|
63755
|
+
"additionalProperties": false,
|
|
63756
|
+
"type": "object",
|
|
63757
|
+
"required": [
|
|
63758
|
+
"sets"
|
|
63759
|
+
],
|
|
63760
|
+
"properties": {
|
|
63761
|
+
"sets": {
|
|
63762
|
+
"type": "array",
|
|
63763
|
+
"items": {
|
|
63764
|
+
"additionalProperties": false,
|
|
63765
|
+
"type": "object",
|
|
63766
|
+
"required": [
|
|
63767
|
+
"id",
|
|
63768
|
+
"name",
|
|
63769
|
+
"groups",
|
|
63770
|
+
"created_by",
|
|
63771
|
+
"created_at"
|
|
63772
|
+
],
|
|
63773
|
+
"properties": {
|
|
63774
|
+
"id": {
|
|
63775
|
+
"format": "uuid",
|
|
63776
|
+
"type": "string"
|
|
63777
|
+
},
|
|
63778
|
+
"name": {
|
|
63779
|
+
"type": "string"
|
|
63780
|
+
},
|
|
63781
|
+
"groups": {
|
|
63782
|
+
"minItems": 1,
|
|
63783
|
+
"maxItems": 20,
|
|
63784
|
+
"description": "The filter groups, in the same shape as the `campaign_filters` parameter of /analytics/ad-metrics and the other ADV endpoints.",
|
|
63785
|
+
"type": "array",
|
|
63786
|
+
"items": {
|
|
63787
|
+
"additionalProperties": false,
|
|
63788
|
+
"type": "object",
|
|
63789
|
+
"required": [
|
|
63790
|
+
"platform",
|
|
63791
|
+
"mode",
|
|
63792
|
+
"match",
|
|
63793
|
+
"rules"
|
|
63794
|
+
],
|
|
63795
|
+
"properties": {
|
|
63796
|
+
"platform": {
|
|
63797
|
+
"minLength": 1,
|
|
63798
|
+
"maxLength": 20,
|
|
63799
|
+
"pattern": "^[a-z0-9_]+$",
|
|
63800
|
+
"type": "string"
|
|
63801
|
+
},
|
|
63802
|
+
"ad_account_ids": {
|
|
63803
|
+
"maxItems": 200,
|
|
63804
|
+
"type": "array",
|
|
63805
|
+
"items": {
|
|
63806
|
+
"minLength": 1,
|
|
63807
|
+
"maxLength": 50,
|
|
63808
|
+
"type": "string"
|
|
63809
|
+
}
|
|
63810
|
+
},
|
|
63811
|
+
"mode": {
|
|
63812
|
+
"anyOf": [
|
|
63813
|
+
{
|
|
63814
|
+
"type": "string",
|
|
63815
|
+
"enum": [
|
|
63816
|
+
"include"
|
|
63817
|
+
]
|
|
63818
|
+
},
|
|
63819
|
+
{
|
|
63820
|
+
"type": "string",
|
|
63821
|
+
"enum": [
|
|
63822
|
+
"exclude"
|
|
63823
|
+
]
|
|
63824
|
+
}
|
|
63825
|
+
]
|
|
63826
|
+
},
|
|
63827
|
+
"match": {
|
|
63828
|
+
"anyOf": [
|
|
63829
|
+
{
|
|
63830
|
+
"type": "string",
|
|
63831
|
+
"enum": [
|
|
63832
|
+
"all"
|
|
63833
|
+
]
|
|
63834
|
+
},
|
|
63835
|
+
{
|
|
63836
|
+
"type": "string",
|
|
63837
|
+
"enum": [
|
|
63838
|
+
"any"
|
|
63839
|
+
]
|
|
63840
|
+
}
|
|
63841
|
+
]
|
|
63842
|
+
},
|
|
63843
|
+
"rules": {
|
|
63844
|
+
"minItems": 1,
|
|
63845
|
+
"maxItems": 20,
|
|
63846
|
+
"type": "array",
|
|
63847
|
+
"items": {
|
|
63848
|
+
"anyOf": [
|
|
63849
|
+
{
|
|
63850
|
+
"additionalProperties": false,
|
|
63851
|
+
"type": "object",
|
|
63852
|
+
"required": [
|
|
63853
|
+
"type",
|
|
63854
|
+
"field",
|
|
63855
|
+
"operator",
|
|
63856
|
+
"value"
|
|
63857
|
+
],
|
|
63858
|
+
"properties": {
|
|
63859
|
+
"type": {
|
|
63860
|
+
"type": "string",
|
|
63861
|
+
"enum": [
|
|
63862
|
+
"text"
|
|
63863
|
+
]
|
|
63864
|
+
},
|
|
63865
|
+
"field": {
|
|
63866
|
+
"anyOf": [
|
|
63867
|
+
{
|
|
63868
|
+
"type": "string",
|
|
63869
|
+
"enum": [
|
|
63870
|
+
"bid_strategy"
|
|
63871
|
+
]
|
|
63872
|
+
},
|
|
63873
|
+
{
|
|
63874
|
+
"type": "string",
|
|
63875
|
+
"enum": [
|
|
63876
|
+
"campaign_id"
|
|
63877
|
+
]
|
|
63878
|
+
},
|
|
63879
|
+
{
|
|
63880
|
+
"type": "string",
|
|
63881
|
+
"enum": [
|
|
63882
|
+
"campaign_name"
|
|
63883
|
+
]
|
|
63884
|
+
},
|
|
63885
|
+
{
|
|
63886
|
+
"type": "string",
|
|
63887
|
+
"enum": [
|
|
63888
|
+
"campaign_status"
|
|
63889
|
+
]
|
|
63890
|
+
},
|
|
63891
|
+
{
|
|
63892
|
+
"type": "string",
|
|
63893
|
+
"enum": [
|
|
63894
|
+
"objective"
|
|
63895
|
+
]
|
|
63896
|
+
}
|
|
63897
|
+
]
|
|
63898
|
+
},
|
|
63899
|
+
"operator": {
|
|
63900
|
+
"anyOf": [
|
|
63901
|
+
{
|
|
63902
|
+
"type": "string",
|
|
63903
|
+
"enum": [
|
|
63904
|
+
"contains"
|
|
63905
|
+
]
|
|
63906
|
+
},
|
|
63907
|
+
{
|
|
63908
|
+
"type": "string",
|
|
63909
|
+
"enum": [
|
|
63910
|
+
"not_contains"
|
|
63911
|
+
]
|
|
63912
|
+
},
|
|
63913
|
+
{
|
|
63914
|
+
"type": "string",
|
|
63915
|
+
"enum": [
|
|
63916
|
+
"equals"
|
|
63917
|
+
]
|
|
63918
|
+
},
|
|
63919
|
+
{
|
|
63920
|
+
"type": "string",
|
|
63921
|
+
"enum": [
|
|
63922
|
+
"not_equals"
|
|
63923
|
+
]
|
|
63924
|
+
}
|
|
63925
|
+
]
|
|
63926
|
+
},
|
|
63927
|
+
"value": {
|
|
63928
|
+
"minLength": 1,
|
|
63929
|
+
"maxLength": 500,
|
|
63930
|
+
"type": "string"
|
|
63931
|
+
}
|
|
63932
|
+
}
|
|
63933
|
+
},
|
|
63934
|
+
{
|
|
63935
|
+
"additionalProperties": false,
|
|
63936
|
+
"type": "object",
|
|
63937
|
+
"required": [
|
|
63938
|
+
"type",
|
|
63939
|
+
"field",
|
|
63940
|
+
"operator",
|
|
63941
|
+
"value"
|
|
63942
|
+
],
|
|
63943
|
+
"properties": {
|
|
63944
|
+
"type": {
|
|
63945
|
+
"type": "string",
|
|
63946
|
+
"enum": [
|
|
63947
|
+
"number"
|
|
63948
|
+
]
|
|
63949
|
+
},
|
|
63950
|
+
"field": {
|
|
63951
|
+
"anyOf": [
|
|
63952
|
+
{
|
|
63953
|
+
"type": "string",
|
|
63954
|
+
"enum": [
|
|
63955
|
+
"add_to_cart"
|
|
63956
|
+
]
|
|
63957
|
+
},
|
|
63958
|
+
{
|
|
63959
|
+
"type": "string",
|
|
63960
|
+
"enum": [
|
|
63961
|
+
"clicks"
|
|
63962
|
+
]
|
|
63963
|
+
},
|
|
63964
|
+
{
|
|
63965
|
+
"type": "string",
|
|
63966
|
+
"enum": [
|
|
63967
|
+
"cpa"
|
|
63968
|
+
]
|
|
63969
|
+
},
|
|
63970
|
+
{
|
|
63971
|
+
"type": "string",
|
|
63972
|
+
"enum": [
|
|
63973
|
+
"cpc"
|
|
63974
|
+
]
|
|
63975
|
+
},
|
|
63976
|
+
{
|
|
63977
|
+
"type": "string",
|
|
63978
|
+
"enum": [
|
|
63979
|
+
"cpm"
|
|
63980
|
+
]
|
|
63981
|
+
},
|
|
63982
|
+
{
|
|
63983
|
+
"type": "string",
|
|
63984
|
+
"enum": [
|
|
63985
|
+
"ctr"
|
|
63986
|
+
]
|
|
63987
|
+
},
|
|
63988
|
+
{
|
|
63989
|
+
"type": "string",
|
|
63990
|
+
"enum": [
|
|
63991
|
+
"cvr"
|
|
63992
|
+
]
|
|
63993
|
+
},
|
|
63994
|
+
{
|
|
63995
|
+
"type": "string",
|
|
63996
|
+
"enum": [
|
|
63997
|
+
"frequency"
|
|
63998
|
+
]
|
|
63999
|
+
},
|
|
64000
|
+
{
|
|
64001
|
+
"type": "string",
|
|
64002
|
+
"enum": [
|
|
64003
|
+
"impressions"
|
|
64004
|
+
]
|
|
64005
|
+
},
|
|
64006
|
+
{
|
|
64007
|
+
"type": "string",
|
|
64008
|
+
"enum": [
|
|
64009
|
+
"inline_link_clicks"
|
|
64010
|
+
]
|
|
64011
|
+
},
|
|
64012
|
+
{
|
|
64013
|
+
"type": "string",
|
|
64014
|
+
"enum": [
|
|
64015
|
+
"leads"
|
|
64016
|
+
]
|
|
64017
|
+
},
|
|
64018
|
+
{
|
|
64019
|
+
"type": "string",
|
|
64020
|
+
"enum": [
|
|
64021
|
+
"purchase_value"
|
|
64022
|
+
]
|
|
64023
|
+
},
|
|
64024
|
+
{
|
|
64025
|
+
"type": "string",
|
|
64026
|
+
"enum": [
|
|
64027
|
+
"purchases"
|
|
64028
|
+
]
|
|
64029
|
+
},
|
|
64030
|
+
{
|
|
64031
|
+
"type": "string",
|
|
64032
|
+
"enum": [
|
|
64033
|
+
"reach"
|
|
64034
|
+
]
|
|
64035
|
+
},
|
|
64036
|
+
{
|
|
64037
|
+
"type": "string",
|
|
64038
|
+
"enum": [
|
|
64039
|
+
"roas"
|
|
64040
|
+
]
|
|
64041
|
+
},
|
|
64042
|
+
{
|
|
64043
|
+
"type": "string",
|
|
64044
|
+
"enum": [
|
|
64045
|
+
"spend"
|
|
64046
|
+
]
|
|
64047
|
+
}
|
|
64048
|
+
]
|
|
64049
|
+
},
|
|
64050
|
+
"operator": {
|
|
64051
|
+
"anyOf": [
|
|
64052
|
+
{
|
|
64053
|
+
"type": "string",
|
|
64054
|
+
"enum": [
|
|
64055
|
+
"gt"
|
|
64056
|
+
]
|
|
64057
|
+
},
|
|
64058
|
+
{
|
|
64059
|
+
"type": "string",
|
|
64060
|
+
"enum": [
|
|
64061
|
+
"gte"
|
|
64062
|
+
]
|
|
64063
|
+
},
|
|
64064
|
+
{
|
|
64065
|
+
"type": "string",
|
|
64066
|
+
"enum": [
|
|
64067
|
+
"lt"
|
|
64068
|
+
]
|
|
64069
|
+
},
|
|
64070
|
+
{
|
|
64071
|
+
"type": "string",
|
|
64072
|
+
"enum": [
|
|
64073
|
+
"lte"
|
|
64074
|
+
]
|
|
64075
|
+
},
|
|
64076
|
+
{
|
|
64077
|
+
"type": "string",
|
|
64078
|
+
"enum": [
|
|
64079
|
+
"eq"
|
|
64080
|
+
]
|
|
64081
|
+
},
|
|
64082
|
+
{
|
|
64083
|
+
"type": "string",
|
|
64084
|
+
"enum": [
|
|
64085
|
+
"between"
|
|
64086
|
+
]
|
|
64087
|
+
}
|
|
64088
|
+
]
|
|
64089
|
+
},
|
|
64090
|
+
"value": {
|
|
64091
|
+
"type": "number"
|
|
64092
|
+
},
|
|
64093
|
+
"value_to": {
|
|
64094
|
+
"type": "number"
|
|
64095
|
+
}
|
|
64096
|
+
}
|
|
64097
|
+
},
|
|
64098
|
+
{
|
|
64099
|
+
"additionalProperties": false,
|
|
64100
|
+
"type": "object",
|
|
64101
|
+
"required": [
|
|
64102
|
+
"type",
|
|
64103
|
+
"field",
|
|
64104
|
+
"operator",
|
|
64105
|
+
"value"
|
|
64106
|
+
],
|
|
64107
|
+
"properties": {
|
|
64108
|
+
"type": {
|
|
64109
|
+
"type": "string",
|
|
64110
|
+
"enum": [
|
|
64111
|
+
"label"
|
|
64112
|
+
]
|
|
64113
|
+
},
|
|
64114
|
+
"field": {
|
|
64115
|
+
"anyOf": [
|
|
64116
|
+
{
|
|
64117
|
+
"type": "string",
|
|
64118
|
+
"enum": [
|
|
64119
|
+
"product"
|
|
64120
|
+
]
|
|
64121
|
+
},
|
|
64122
|
+
{
|
|
64123
|
+
"type": "string",
|
|
64124
|
+
"enum": [
|
|
64125
|
+
"vertical"
|
|
64126
|
+
]
|
|
64127
|
+
},
|
|
64128
|
+
{
|
|
64129
|
+
"type": "string",
|
|
64130
|
+
"enum": [
|
|
64131
|
+
"funnel"
|
|
64132
|
+
]
|
|
64133
|
+
},
|
|
64134
|
+
{
|
|
64135
|
+
"type": "string",
|
|
64136
|
+
"enum": [
|
|
64137
|
+
"market"
|
|
64138
|
+
]
|
|
64139
|
+
}
|
|
64140
|
+
]
|
|
64141
|
+
},
|
|
64142
|
+
"operator": {
|
|
64143
|
+
"anyOf": [
|
|
64144
|
+
{
|
|
64145
|
+
"type": "string",
|
|
64146
|
+
"enum": [
|
|
64147
|
+
"equals"
|
|
64148
|
+
]
|
|
64149
|
+
},
|
|
64150
|
+
{
|
|
64151
|
+
"type": "string",
|
|
64152
|
+
"enum": [
|
|
64153
|
+
"not_equals"
|
|
64154
|
+
]
|
|
64155
|
+
}
|
|
64156
|
+
]
|
|
64157
|
+
},
|
|
64158
|
+
"value": {
|
|
64159
|
+
"minLength": 1,
|
|
64160
|
+
"maxLength": 200,
|
|
64161
|
+
"type": "string"
|
|
64162
|
+
}
|
|
64163
|
+
}
|
|
64164
|
+
}
|
|
64165
|
+
]
|
|
64166
|
+
}
|
|
64167
|
+
}
|
|
64168
|
+
}
|
|
64169
|
+
}
|
|
64170
|
+
},
|
|
64171
|
+
"created_by": {
|
|
64172
|
+
"description": "Who saved it; null when that user no longer exists.",
|
|
64173
|
+
"anyOf": [
|
|
64174
|
+
{
|
|
64175
|
+
"format": "uuid",
|
|
64176
|
+
"type": "string"
|
|
64177
|
+
},
|
|
64178
|
+
{
|
|
64179
|
+
"type": "null"
|
|
64180
|
+
}
|
|
64181
|
+
]
|
|
64182
|
+
},
|
|
64183
|
+
"created_at": {
|
|
64184
|
+
"format": "date-time",
|
|
64185
|
+
"type": "string"
|
|
64186
|
+
}
|
|
64187
|
+
}
|
|
64188
|
+
}
|
|
64189
|
+
}
|
|
64190
|
+
}
|
|
64191
|
+
}
|
|
64192
|
+
}
|
|
64193
|
+
}
|
|
64194
|
+
},
|
|
64195
|
+
"400": {
|
|
64196
|
+
"description": "Explicit destination workspace required: send the x-team-id header or activate a team scope for this operation.",
|
|
64197
|
+
"content": {
|
|
64198
|
+
"application/json": {
|
|
64199
|
+
"schema": {
|
|
64200
|
+
"description": "Explicit destination workspace required: send the x-team-id header or activate a team scope for this operation.",
|
|
64201
|
+
"additionalProperties": false,
|
|
64202
|
+
"type": "object",
|
|
64203
|
+
"required": [
|
|
64204
|
+
"statusCode",
|
|
64205
|
+
"error",
|
|
64206
|
+
"message"
|
|
64207
|
+
],
|
|
64208
|
+
"properties": {
|
|
64209
|
+
"statusCode": {
|
|
64210
|
+
"type": "number"
|
|
64211
|
+
},
|
|
64212
|
+
"error": {
|
|
64213
|
+
"type": "string"
|
|
64214
|
+
},
|
|
64215
|
+
"message": {
|
|
64216
|
+
"type": "string"
|
|
64217
|
+
},
|
|
64218
|
+
"code": {
|
|
64219
|
+
"description": "`SCOPE_TEAM_REQUIRED` when no destination workspace was given; a validation 400 keeps its own code (e.g. `FST_ERR_VALIDATION`).",
|
|
64220
|
+
"type": "string"
|
|
64221
|
+
}
|
|
64222
|
+
}
|
|
64223
|
+
}
|
|
64224
|
+
}
|
|
64225
|
+
}
|
|
64226
|
+
},
|
|
64227
|
+
"401": {
|
|
64228
|
+
"description": "Unauthorized - missing or invalid bearer token",
|
|
64229
|
+
"content": {
|
|
64230
|
+
"application/json": {
|
|
64231
|
+
"schema": {
|
|
64232
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
64233
|
+
}
|
|
64234
|
+
}
|
|
64235
|
+
}
|
|
64236
|
+
},
|
|
64237
|
+
"503": {
|
|
64238
|
+
"description": "Session revocation check unavailable (Redis): retry after the Retry-After header.",
|
|
64239
|
+
"headers": {
|
|
64240
|
+
"Retry-After": {
|
|
64241
|
+
"description": "Seconds to wait before retrying the identical request.",
|
|
64242
|
+
"schema": {
|
|
64243
|
+
"type": "integer"
|
|
64244
|
+
}
|
|
64245
|
+
}
|
|
64246
|
+
},
|
|
64247
|
+
"content": {
|
|
64248
|
+
"application/json": {
|
|
64249
|
+
"schema": {
|
|
64250
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
64251
|
+
}
|
|
64252
|
+
}
|
|
64253
|
+
}
|
|
64254
|
+
}
|
|
64255
|
+
}
|
|
64256
|
+
},
|
|
64257
|
+
"post": {
|
|
64258
|
+
"operationId": "createAnalyticsCampaignFilterSet",
|
|
64259
|
+
"summary": "Save a campaign filter set",
|
|
64260
|
+
"tags": [
|
|
64261
|
+
"analytics"
|
|
64262
|
+
],
|
|
64263
|
+
"description": "Saves the given filter groups under a name, for every member of the workspace. The name is unique in the workspace regardless of case (409 FILTER_SET_NAME_TAKEN), and a workspace keeps at most 20 sets (409 FILTER_SET_LIMIT_REACHED).",
|
|
64264
|
+
"requestBody": {
|
|
64265
|
+
"required": true,
|
|
64266
|
+
"content": {
|
|
64267
|
+
"application/json": {
|
|
64268
|
+
"schema": {
|
|
64269
|
+
"additionalProperties": false,
|
|
64270
|
+
"type": "object",
|
|
64271
|
+
"required": [
|
|
64272
|
+
"name",
|
|
64273
|
+
"groups"
|
|
64274
|
+
],
|
|
64275
|
+
"properties": {
|
|
64276
|
+
"name": {
|
|
64277
|
+
"minLength": 1,
|
|
64278
|
+
"maxLength": 100,
|
|
64279
|
+
"pattern": "\\S",
|
|
64280
|
+
"description": "Name shown in the menu.",
|
|
64281
|
+
"type": "string"
|
|
64282
|
+
},
|
|
64283
|
+
"groups": {
|
|
64284
|
+
"minItems": 1,
|
|
64285
|
+
"maxItems": 20,
|
|
64286
|
+
"description": "The filter groups, in the same shape as the `campaign_filters` parameter of /analytics/ad-metrics and the other ADV endpoints.",
|
|
64287
|
+
"type": "array",
|
|
64288
|
+
"items": {
|
|
64289
|
+
"additionalProperties": false,
|
|
64290
|
+
"type": "object",
|
|
64291
|
+
"required": [
|
|
64292
|
+
"platform",
|
|
64293
|
+
"mode",
|
|
64294
|
+
"match",
|
|
64295
|
+
"rules"
|
|
64296
|
+
],
|
|
64297
|
+
"properties": {
|
|
64298
|
+
"platform": {
|
|
64299
|
+
"minLength": 1,
|
|
64300
|
+
"maxLength": 20,
|
|
64301
|
+
"pattern": "^[a-z0-9_]+$",
|
|
64302
|
+
"type": "string"
|
|
64303
|
+
},
|
|
64304
|
+
"ad_account_ids": {
|
|
64305
|
+
"maxItems": 200,
|
|
64306
|
+
"type": "array",
|
|
64307
|
+
"items": {
|
|
64308
|
+
"minLength": 1,
|
|
64309
|
+
"maxLength": 50,
|
|
64310
|
+
"type": "string"
|
|
64311
|
+
}
|
|
64312
|
+
},
|
|
64313
|
+
"mode": {
|
|
64314
|
+
"anyOf": [
|
|
64315
|
+
{
|
|
64316
|
+
"type": "string",
|
|
64317
|
+
"enum": [
|
|
64318
|
+
"include"
|
|
64319
|
+
]
|
|
64320
|
+
},
|
|
64321
|
+
{
|
|
64322
|
+
"type": "string",
|
|
64323
|
+
"enum": [
|
|
64324
|
+
"exclude"
|
|
64325
|
+
]
|
|
64326
|
+
}
|
|
64327
|
+
]
|
|
64328
|
+
},
|
|
64329
|
+
"match": {
|
|
64330
|
+
"anyOf": [
|
|
64331
|
+
{
|
|
64332
|
+
"type": "string",
|
|
64333
|
+
"enum": [
|
|
64334
|
+
"all"
|
|
64335
|
+
]
|
|
64336
|
+
},
|
|
64337
|
+
{
|
|
64338
|
+
"type": "string",
|
|
64339
|
+
"enum": [
|
|
64340
|
+
"any"
|
|
64341
|
+
]
|
|
64342
|
+
}
|
|
64343
|
+
]
|
|
64344
|
+
},
|
|
64345
|
+
"rules": {
|
|
64346
|
+
"minItems": 1,
|
|
64347
|
+
"maxItems": 20,
|
|
64348
|
+
"type": "array",
|
|
64349
|
+
"items": {
|
|
64350
|
+
"anyOf": [
|
|
64351
|
+
{
|
|
64352
|
+
"additionalProperties": false,
|
|
64353
|
+
"type": "object",
|
|
64354
|
+
"required": [
|
|
64355
|
+
"type",
|
|
64356
|
+
"field",
|
|
64357
|
+
"operator",
|
|
64358
|
+
"value"
|
|
64359
|
+
],
|
|
64360
|
+
"properties": {
|
|
64361
|
+
"type": {
|
|
64362
|
+
"type": "string",
|
|
64363
|
+
"enum": [
|
|
64364
|
+
"text"
|
|
64365
|
+
]
|
|
64366
|
+
},
|
|
64367
|
+
"field": {
|
|
64368
|
+
"anyOf": [
|
|
64369
|
+
{
|
|
64370
|
+
"type": "string",
|
|
64371
|
+
"enum": [
|
|
64372
|
+
"bid_strategy"
|
|
64373
|
+
]
|
|
64374
|
+
},
|
|
64375
|
+
{
|
|
64376
|
+
"type": "string",
|
|
64377
|
+
"enum": [
|
|
64378
|
+
"campaign_id"
|
|
64379
|
+
]
|
|
64380
|
+
},
|
|
64381
|
+
{
|
|
64382
|
+
"type": "string",
|
|
64383
|
+
"enum": [
|
|
64384
|
+
"campaign_name"
|
|
64385
|
+
]
|
|
64386
|
+
},
|
|
64387
|
+
{
|
|
64388
|
+
"type": "string",
|
|
64389
|
+
"enum": [
|
|
64390
|
+
"campaign_status"
|
|
64391
|
+
]
|
|
64392
|
+
},
|
|
64393
|
+
{
|
|
64394
|
+
"type": "string",
|
|
64395
|
+
"enum": [
|
|
64396
|
+
"objective"
|
|
64397
|
+
]
|
|
64398
|
+
}
|
|
64399
|
+
]
|
|
64400
|
+
},
|
|
64401
|
+
"operator": {
|
|
64402
|
+
"anyOf": [
|
|
64403
|
+
{
|
|
64404
|
+
"type": "string",
|
|
64405
|
+
"enum": [
|
|
64406
|
+
"contains"
|
|
64407
|
+
]
|
|
64408
|
+
},
|
|
64409
|
+
{
|
|
64410
|
+
"type": "string",
|
|
64411
|
+
"enum": [
|
|
64412
|
+
"not_contains"
|
|
64413
|
+
]
|
|
64414
|
+
},
|
|
64415
|
+
{
|
|
64416
|
+
"type": "string",
|
|
64417
|
+
"enum": [
|
|
64418
|
+
"equals"
|
|
64419
|
+
]
|
|
64420
|
+
},
|
|
64421
|
+
{
|
|
64422
|
+
"type": "string",
|
|
64423
|
+
"enum": [
|
|
64424
|
+
"not_equals"
|
|
64425
|
+
]
|
|
64426
|
+
}
|
|
64427
|
+
]
|
|
64428
|
+
},
|
|
64429
|
+
"value": {
|
|
64430
|
+
"minLength": 1,
|
|
64431
|
+
"maxLength": 500,
|
|
64432
|
+
"type": "string"
|
|
64433
|
+
}
|
|
64434
|
+
}
|
|
64435
|
+
},
|
|
64436
|
+
{
|
|
64437
|
+
"additionalProperties": false,
|
|
64438
|
+
"type": "object",
|
|
64439
|
+
"required": [
|
|
64440
|
+
"type",
|
|
64441
|
+
"field",
|
|
64442
|
+
"operator",
|
|
64443
|
+
"value"
|
|
64444
|
+
],
|
|
64445
|
+
"properties": {
|
|
64446
|
+
"type": {
|
|
64447
|
+
"type": "string",
|
|
64448
|
+
"enum": [
|
|
64449
|
+
"number"
|
|
64450
|
+
]
|
|
64451
|
+
},
|
|
64452
|
+
"field": {
|
|
64453
|
+
"anyOf": [
|
|
64454
|
+
{
|
|
64455
|
+
"type": "string",
|
|
64456
|
+
"enum": [
|
|
64457
|
+
"add_to_cart"
|
|
64458
|
+
]
|
|
64459
|
+
},
|
|
64460
|
+
{
|
|
64461
|
+
"type": "string",
|
|
64462
|
+
"enum": [
|
|
64463
|
+
"clicks"
|
|
64464
|
+
]
|
|
64465
|
+
},
|
|
64466
|
+
{
|
|
64467
|
+
"type": "string",
|
|
64468
|
+
"enum": [
|
|
64469
|
+
"cpa"
|
|
64470
|
+
]
|
|
64471
|
+
},
|
|
64472
|
+
{
|
|
64473
|
+
"type": "string",
|
|
64474
|
+
"enum": [
|
|
64475
|
+
"cpc"
|
|
64476
|
+
]
|
|
64477
|
+
},
|
|
64478
|
+
{
|
|
64479
|
+
"type": "string",
|
|
64480
|
+
"enum": [
|
|
64481
|
+
"cpm"
|
|
64482
|
+
]
|
|
64483
|
+
},
|
|
64484
|
+
{
|
|
64485
|
+
"type": "string",
|
|
64486
|
+
"enum": [
|
|
64487
|
+
"ctr"
|
|
64488
|
+
]
|
|
64489
|
+
},
|
|
64490
|
+
{
|
|
64491
|
+
"type": "string",
|
|
64492
|
+
"enum": [
|
|
64493
|
+
"cvr"
|
|
64494
|
+
]
|
|
64495
|
+
},
|
|
64496
|
+
{
|
|
64497
|
+
"type": "string",
|
|
64498
|
+
"enum": [
|
|
64499
|
+
"frequency"
|
|
64500
|
+
]
|
|
64501
|
+
},
|
|
64502
|
+
{
|
|
64503
|
+
"type": "string",
|
|
64504
|
+
"enum": [
|
|
64505
|
+
"impressions"
|
|
64506
|
+
]
|
|
64507
|
+
},
|
|
64508
|
+
{
|
|
64509
|
+
"type": "string",
|
|
64510
|
+
"enum": [
|
|
64511
|
+
"inline_link_clicks"
|
|
64512
|
+
]
|
|
64513
|
+
},
|
|
64514
|
+
{
|
|
64515
|
+
"type": "string",
|
|
64516
|
+
"enum": [
|
|
64517
|
+
"leads"
|
|
64518
|
+
]
|
|
64519
|
+
},
|
|
64520
|
+
{
|
|
64521
|
+
"type": "string",
|
|
64522
|
+
"enum": [
|
|
64523
|
+
"purchase_value"
|
|
64524
|
+
]
|
|
64525
|
+
},
|
|
64526
|
+
{
|
|
64527
|
+
"type": "string",
|
|
64528
|
+
"enum": [
|
|
64529
|
+
"purchases"
|
|
64530
|
+
]
|
|
64531
|
+
},
|
|
64532
|
+
{
|
|
64533
|
+
"type": "string",
|
|
64534
|
+
"enum": [
|
|
64535
|
+
"reach"
|
|
64536
|
+
]
|
|
64537
|
+
},
|
|
64538
|
+
{
|
|
64539
|
+
"type": "string",
|
|
64540
|
+
"enum": [
|
|
64541
|
+
"roas"
|
|
64542
|
+
]
|
|
64543
|
+
},
|
|
64544
|
+
{
|
|
64545
|
+
"type": "string",
|
|
64546
|
+
"enum": [
|
|
64547
|
+
"spend"
|
|
64548
|
+
]
|
|
64549
|
+
}
|
|
64550
|
+
]
|
|
64551
|
+
},
|
|
64552
|
+
"operator": {
|
|
64553
|
+
"anyOf": [
|
|
64554
|
+
{
|
|
64555
|
+
"type": "string",
|
|
64556
|
+
"enum": [
|
|
64557
|
+
"gt"
|
|
64558
|
+
]
|
|
64559
|
+
},
|
|
64560
|
+
{
|
|
64561
|
+
"type": "string",
|
|
64562
|
+
"enum": [
|
|
64563
|
+
"gte"
|
|
64564
|
+
]
|
|
64565
|
+
},
|
|
64566
|
+
{
|
|
64567
|
+
"type": "string",
|
|
64568
|
+
"enum": [
|
|
64569
|
+
"lt"
|
|
64570
|
+
]
|
|
64571
|
+
},
|
|
64572
|
+
{
|
|
64573
|
+
"type": "string",
|
|
64574
|
+
"enum": [
|
|
64575
|
+
"lte"
|
|
64576
|
+
]
|
|
64577
|
+
},
|
|
64578
|
+
{
|
|
64579
|
+
"type": "string",
|
|
64580
|
+
"enum": [
|
|
64581
|
+
"eq"
|
|
64582
|
+
]
|
|
64583
|
+
},
|
|
64584
|
+
{
|
|
64585
|
+
"type": "string",
|
|
64586
|
+
"enum": [
|
|
64587
|
+
"between"
|
|
64588
|
+
]
|
|
64589
|
+
}
|
|
64590
|
+
]
|
|
64591
|
+
},
|
|
64592
|
+
"value": {
|
|
64593
|
+
"type": "number"
|
|
64594
|
+
},
|
|
64595
|
+
"value_to": {
|
|
64596
|
+
"type": "number"
|
|
64597
|
+
}
|
|
64598
|
+
}
|
|
64599
|
+
},
|
|
64600
|
+
{
|
|
64601
|
+
"additionalProperties": false,
|
|
64602
|
+
"type": "object",
|
|
64603
|
+
"required": [
|
|
64604
|
+
"type",
|
|
64605
|
+
"field",
|
|
64606
|
+
"operator",
|
|
64607
|
+
"value"
|
|
64608
|
+
],
|
|
64609
|
+
"properties": {
|
|
64610
|
+
"type": {
|
|
64611
|
+
"type": "string",
|
|
64612
|
+
"enum": [
|
|
64613
|
+
"label"
|
|
64614
|
+
]
|
|
64615
|
+
},
|
|
64616
|
+
"field": {
|
|
64617
|
+
"anyOf": [
|
|
64618
|
+
{
|
|
64619
|
+
"type": "string",
|
|
64620
|
+
"enum": [
|
|
64621
|
+
"product"
|
|
64622
|
+
]
|
|
64623
|
+
},
|
|
64624
|
+
{
|
|
64625
|
+
"type": "string",
|
|
64626
|
+
"enum": [
|
|
64627
|
+
"vertical"
|
|
64628
|
+
]
|
|
64629
|
+
},
|
|
64630
|
+
{
|
|
64631
|
+
"type": "string",
|
|
64632
|
+
"enum": [
|
|
64633
|
+
"funnel"
|
|
64634
|
+
]
|
|
64635
|
+
},
|
|
64636
|
+
{
|
|
64637
|
+
"type": "string",
|
|
64638
|
+
"enum": [
|
|
64639
|
+
"market"
|
|
64640
|
+
]
|
|
64641
|
+
}
|
|
64642
|
+
]
|
|
64643
|
+
},
|
|
64644
|
+
"operator": {
|
|
64645
|
+
"anyOf": [
|
|
64646
|
+
{
|
|
64647
|
+
"type": "string",
|
|
64648
|
+
"enum": [
|
|
64649
|
+
"equals"
|
|
64650
|
+
]
|
|
64651
|
+
},
|
|
64652
|
+
{
|
|
64653
|
+
"type": "string",
|
|
64654
|
+
"enum": [
|
|
64655
|
+
"not_equals"
|
|
64656
|
+
]
|
|
64657
|
+
}
|
|
64658
|
+
]
|
|
64659
|
+
},
|
|
64660
|
+
"value": {
|
|
64661
|
+
"minLength": 1,
|
|
64662
|
+
"maxLength": 200,
|
|
64663
|
+
"type": "string"
|
|
64664
|
+
}
|
|
64665
|
+
}
|
|
64666
|
+
}
|
|
64667
|
+
]
|
|
64668
|
+
}
|
|
64669
|
+
}
|
|
64670
|
+
}
|
|
64671
|
+
}
|
|
64672
|
+
}
|
|
64673
|
+
}
|
|
64674
|
+
}
|
|
64675
|
+
}
|
|
64676
|
+
}
|
|
64677
|
+
},
|
|
64678
|
+
"parameters": [
|
|
64679
|
+
{
|
|
64680
|
+
"schema": {
|
|
64681
|
+
"format": "uuid",
|
|
64682
|
+
"type": "string"
|
|
64683
|
+
},
|
|
64684
|
+
"in": "header",
|
|
64685
|
+
"name": "x-team-id",
|
|
64686
|
+
"required": false,
|
|
64687
|
+
"description": "Destination workspace team id."
|
|
64688
|
+
}
|
|
64689
|
+
],
|
|
64690
|
+
"security": [
|
|
64691
|
+
{
|
|
64692
|
+
"bearerAuth": []
|
|
64693
|
+
}
|
|
64694
|
+
],
|
|
64695
|
+
"responses": {
|
|
64696
|
+
"201": {
|
|
64697
|
+
"description": "Resource created",
|
|
64698
|
+
"content": {
|
|
64699
|
+
"application/json": {
|
|
64700
|
+
"schema": {
|
|
64701
|
+
"additionalProperties": false,
|
|
64702
|
+
"type": "object",
|
|
64703
|
+
"required": [
|
|
64704
|
+
"id",
|
|
64705
|
+
"name",
|
|
64706
|
+
"groups",
|
|
64707
|
+
"created_by",
|
|
64708
|
+
"created_at"
|
|
64709
|
+
],
|
|
64710
|
+
"properties": {
|
|
64711
|
+
"id": {
|
|
64712
|
+
"format": "uuid",
|
|
64713
|
+
"type": "string"
|
|
64714
|
+
},
|
|
64715
|
+
"name": {
|
|
64716
|
+
"type": "string"
|
|
64717
|
+
},
|
|
64718
|
+
"groups": {
|
|
64719
|
+
"minItems": 1,
|
|
64720
|
+
"maxItems": 20,
|
|
64721
|
+
"description": "The filter groups, in the same shape as the `campaign_filters` parameter of /analytics/ad-metrics and the other ADV endpoints.",
|
|
64722
|
+
"type": "array",
|
|
64723
|
+
"items": {
|
|
64724
|
+
"additionalProperties": false,
|
|
64725
|
+
"type": "object",
|
|
64726
|
+
"required": [
|
|
64727
|
+
"platform",
|
|
64728
|
+
"mode",
|
|
64729
|
+
"match",
|
|
64730
|
+
"rules"
|
|
64731
|
+
],
|
|
64732
|
+
"properties": {
|
|
64733
|
+
"platform": {
|
|
64734
|
+
"minLength": 1,
|
|
64735
|
+
"maxLength": 20,
|
|
64736
|
+
"pattern": "^[a-z0-9_]+$",
|
|
64737
|
+
"type": "string"
|
|
64738
|
+
},
|
|
64739
|
+
"ad_account_ids": {
|
|
64740
|
+
"maxItems": 200,
|
|
64741
|
+
"type": "array",
|
|
64742
|
+
"items": {
|
|
64743
|
+
"minLength": 1,
|
|
64744
|
+
"maxLength": 50,
|
|
64745
|
+
"type": "string"
|
|
64746
|
+
}
|
|
64747
|
+
},
|
|
64748
|
+
"mode": {
|
|
64749
|
+
"anyOf": [
|
|
64750
|
+
{
|
|
64751
|
+
"type": "string",
|
|
64752
|
+
"enum": [
|
|
64753
|
+
"include"
|
|
64754
|
+
]
|
|
64755
|
+
},
|
|
64756
|
+
{
|
|
64757
|
+
"type": "string",
|
|
64758
|
+
"enum": [
|
|
64759
|
+
"exclude"
|
|
64760
|
+
]
|
|
64761
|
+
}
|
|
64762
|
+
]
|
|
64763
|
+
},
|
|
64764
|
+
"match": {
|
|
64765
|
+
"anyOf": [
|
|
64766
|
+
{
|
|
64767
|
+
"type": "string",
|
|
64768
|
+
"enum": [
|
|
64769
|
+
"all"
|
|
64770
|
+
]
|
|
64771
|
+
},
|
|
64772
|
+
{
|
|
64773
|
+
"type": "string",
|
|
64774
|
+
"enum": [
|
|
64775
|
+
"any"
|
|
64776
|
+
]
|
|
64777
|
+
}
|
|
64778
|
+
]
|
|
64779
|
+
},
|
|
64780
|
+
"rules": {
|
|
64781
|
+
"minItems": 1,
|
|
64782
|
+
"maxItems": 20,
|
|
64783
|
+
"type": "array",
|
|
64784
|
+
"items": {
|
|
64785
|
+
"anyOf": [
|
|
64786
|
+
{
|
|
64787
|
+
"additionalProperties": false,
|
|
64788
|
+
"type": "object",
|
|
64789
|
+
"required": [
|
|
64790
|
+
"type",
|
|
64791
|
+
"field",
|
|
64792
|
+
"operator",
|
|
64793
|
+
"value"
|
|
64794
|
+
],
|
|
64795
|
+
"properties": {
|
|
64796
|
+
"type": {
|
|
64797
|
+
"type": "string",
|
|
64798
|
+
"enum": [
|
|
64799
|
+
"text"
|
|
64800
|
+
]
|
|
64801
|
+
},
|
|
64802
|
+
"field": {
|
|
64803
|
+
"anyOf": [
|
|
64804
|
+
{
|
|
64805
|
+
"type": "string",
|
|
64806
|
+
"enum": [
|
|
64807
|
+
"bid_strategy"
|
|
64808
|
+
]
|
|
64809
|
+
},
|
|
64810
|
+
{
|
|
64811
|
+
"type": "string",
|
|
64812
|
+
"enum": [
|
|
64813
|
+
"campaign_id"
|
|
64814
|
+
]
|
|
64815
|
+
},
|
|
64816
|
+
{
|
|
64817
|
+
"type": "string",
|
|
64818
|
+
"enum": [
|
|
64819
|
+
"campaign_name"
|
|
64820
|
+
]
|
|
64821
|
+
},
|
|
64822
|
+
{
|
|
64823
|
+
"type": "string",
|
|
64824
|
+
"enum": [
|
|
64825
|
+
"campaign_status"
|
|
64826
|
+
]
|
|
64827
|
+
},
|
|
64828
|
+
{
|
|
64829
|
+
"type": "string",
|
|
64830
|
+
"enum": [
|
|
64831
|
+
"objective"
|
|
64832
|
+
]
|
|
64833
|
+
}
|
|
64834
|
+
]
|
|
64835
|
+
},
|
|
64836
|
+
"operator": {
|
|
64837
|
+
"anyOf": [
|
|
64838
|
+
{
|
|
64839
|
+
"type": "string",
|
|
64840
|
+
"enum": [
|
|
64841
|
+
"contains"
|
|
64842
|
+
]
|
|
64843
|
+
},
|
|
64844
|
+
{
|
|
64845
|
+
"type": "string",
|
|
64846
|
+
"enum": [
|
|
64847
|
+
"not_contains"
|
|
64848
|
+
]
|
|
64849
|
+
},
|
|
64850
|
+
{
|
|
64851
|
+
"type": "string",
|
|
64852
|
+
"enum": [
|
|
64853
|
+
"equals"
|
|
64854
|
+
]
|
|
64855
|
+
},
|
|
64856
|
+
{
|
|
64857
|
+
"type": "string",
|
|
64858
|
+
"enum": [
|
|
64859
|
+
"not_equals"
|
|
64860
|
+
]
|
|
64861
|
+
}
|
|
64862
|
+
]
|
|
64863
|
+
},
|
|
64864
|
+
"value": {
|
|
64865
|
+
"minLength": 1,
|
|
64866
|
+
"maxLength": 500,
|
|
64867
|
+
"type": "string"
|
|
64868
|
+
}
|
|
64869
|
+
}
|
|
64870
|
+
},
|
|
64871
|
+
{
|
|
64872
|
+
"additionalProperties": false,
|
|
64873
|
+
"type": "object",
|
|
64874
|
+
"required": [
|
|
64875
|
+
"type",
|
|
64876
|
+
"field",
|
|
64877
|
+
"operator",
|
|
64878
|
+
"value"
|
|
64879
|
+
],
|
|
64880
|
+
"properties": {
|
|
64881
|
+
"type": {
|
|
64882
|
+
"type": "string",
|
|
64883
|
+
"enum": [
|
|
64884
|
+
"number"
|
|
64885
|
+
]
|
|
64886
|
+
},
|
|
64887
|
+
"field": {
|
|
64888
|
+
"anyOf": [
|
|
64889
|
+
{
|
|
64890
|
+
"type": "string",
|
|
64891
|
+
"enum": [
|
|
64892
|
+
"add_to_cart"
|
|
64893
|
+
]
|
|
64894
|
+
},
|
|
64895
|
+
{
|
|
64896
|
+
"type": "string",
|
|
64897
|
+
"enum": [
|
|
64898
|
+
"clicks"
|
|
64899
|
+
]
|
|
64900
|
+
},
|
|
64901
|
+
{
|
|
64902
|
+
"type": "string",
|
|
64903
|
+
"enum": [
|
|
64904
|
+
"cpa"
|
|
64905
|
+
]
|
|
64906
|
+
},
|
|
64907
|
+
{
|
|
64908
|
+
"type": "string",
|
|
64909
|
+
"enum": [
|
|
64910
|
+
"cpc"
|
|
64911
|
+
]
|
|
64912
|
+
},
|
|
64913
|
+
{
|
|
64914
|
+
"type": "string",
|
|
64915
|
+
"enum": [
|
|
64916
|
+
"cpm"
|
|
64917
|
+
]
|
|
64918
|
+
},
|
|
64919
|
+
{
|
|
64920
|
+
"type": "string",
|
|
64921
|
+
"enum": [
|
|
64922
|
+
"ctr"
|
|
64923
|
+
]
|
|
64924
|
+
},
|
|
64925
|
+
{
|
|
64926
|
+
"type": "string",
|
|
64927
|
+
"enum": [
|
|
64928
|
+
"cvr"
|
|
64929
|
+
]
|
|
64930
|
+
},
|
|
64931
|
+
{
|
|
64932
|
+
"type": "string",
|
|
64933
|
+
"enum": [
|
|
64934
|
+
"frequency"
|
|
64935
|
+
]
|
|
64936
|
+
},
|
|
64937
|
+
{
|
|
64938
|
+
"type": "string",
|
|
64939
|
+
"enum": [
|
|
64940
|
+
"impressions"
|
|
64941
|
+
]
|
|
64942
|
+
},
|
|
64943
|
+
{
|
|
64944
|
+
"type": "string",
|
|
64945
|
+
"enum": [
|
|
64946
|
+
"inline_link_clicks"
|
|
64947
|
+
]
|
|
64948
|
+
},
|
|
64949
|
+
{
|
|
64950
|
+
"type": "string",
|
|
64951
|
+
"enum": [
|
|
64952
|
+
"leads"
|
|
64953
|
+
]
|
|
64954
|
+
},
|
|
64955
|
+
{
|
|
64956
|
+
"type": "string",
|
|
64957
|
+
"enum": [
|
|
64958
|
+
"purchase_value"
|
|
64959
|
+
]
|
|
64960
|
+
},
|
|
64961
|
+
{
|
|
64962
|
+
"type": "string",
|
|
64963
|
+
"enum": [
|
|
64964
|
+
"purchases"
|
|
64965
|
+
]
|
|
64966
|
+
},
|
|
64967
|
+
{
|
|
64968
|
+
"type": "string",
|
|
64969
|
+
"enum": [
|
|
64970
|
+
"reach"
|
|
64971
|
+
]
|
|
64972
|
+
},
|
|
64973
|
+
{
|
|
64974
|
+
"type": "string",
|
|
64975
|
+
"enum": [
|
|
64976
|
+
"roas"
|
|
64977
|
+
]
|
|
64978
|
+
},
|
|
64979
|
+
{
|
|
64980
|
+
"type": "string",
|
|
64981
|
+
"enum": [
|
|
64982
|
+
"spend"
|
|
64983
|
+
]
|
|
64984
|
+
}
|
|
64985
|
+
]
|
|
64986
|
+
},
|
|
64987
|
+
"operator": {
|
|
64988
|
+
"anyOf": [
|
|
64989
|
+
{
|
|
64990
|
+
"type": "string",
|
|
64991
|
+
"enum": [
|
|
64992
|
+
"gt"
|
|
64993
|
+
]
|
|
64994
|
+
},
|
|
64995
|
+
{
|
|
64996
|
+
"type": "string",
|
|
64997
|
+
"enum": [
|
|
64998
|
+
"gte"
|
|
64999
|
+
]
|
|
65000
|
+
},
|
|
65001
|
+
{
|
|
65002
|
+
"type": "string",
|
|
65003
|
+
"enum": [
|
|
65004
|
+
"lt"
|
|
65005
|
+
]
|
|
65006
|
+
},
|
|
65007
|
+
{
|
|
65008
|
+
"type": "string",
|
|
65009
|
+
"enum": [
|
|
65010
|
+
"lte"
|
|
65011
|
+
]
|
|
65012
|
+
},
|
|
65013
|
+
{
|
|
65014
|
+
"type": "string",
|
|
65015
|
+
"enum": [
|
|
65016
|
+
"eq"
|
|
65017
|
+
]
|
|
65018
|
+
},
|
|
65019
|
+
{
|
|
65020
|
+
"type": "string",
|
|
65021
|
+
"enum": [
|
|
65022
|
+
"between"
|
|
65023
|
+
]
|
|
65024
|
+
}
|
|
65025
|
+
]
|
|
65026
|
+
},
|
|
65027
|
+
"value": {
|
|
65028
|
+
"type": "number"
|
|
65029
|
+
},
|
|
65030
|
+
"value_to": {
|
|
65031
|
+
"type": "number"
|
|
65032
|
+
}
|
|
65033
|
+
}
|
|
65034
|
+
},
|
|
65035
|
+
{
|
|
65036
|
+
"additionalProperties": false,
|
|
65037
|
+
"type": "object",
|
|
65038
|
+
"required": [
|
|
65039
|
+
"type",
|
|
65040
|
+
"field",
|
|
65041
|
+
"operator",
|
|
65042
|
+
"value"
|
|
65043
|
+
],
|
|
65044
|
+
"properties": {
|
|
65045
|
+
"type": {
|
|
65046
|
+
"type": "string",
|
|
65047
|
+
"enum": [
|
|
65048
|
+
"label"
|
|
65049
|
+
]
|
|
65050
|
+
},
|
|
65051
|
+
"field": {
|
|
65052
|
+
"anyOf": [
|
|
65053
|
+
{
|
|
65054
|
+
"type": "string",
|
|
65055
|
+
"enum": [
|
|
65056
|
+
"product"
|
|
65057
|
+
]
|
|
65058
|
+
},
|
|
65059
|
+
{
|
|
65060
|
+
"type": "string",
|
|
65061
|
+
"enum": [
|
|
65062
|
+
"vertical"
|
|
65063
|
+
]
|
|
65064
|
+
},
|
|
65065
|
+
{
|
|
65066
|
+
"type": "string",
|
|
65067
|
+
"enum": [
|
|
65068
|
+
"funnel"
|
|
65069
|
+
]
|
|
65070
|
+
},
|
|
65071
|
+
{
|
|
65072
|
+
"type": "string",
|
|
65073
|
+
"enum": [
|
|
65074
|
+
"market"
|
|
65075
|
+
]
|
|
65076
|
+
}
|
|
65077
|
+
]
|
|
65078
|
+
},
|
|
65079
|
+
"operator": {
|
|
65080
|
+
"anyOf": [
|
|
65081
|
+
{
|
|
65082
|
+
"type": "string",
|
|
65083
|
+
"enum": [
|
|
65084
|
+
"equals"
|
|
65085
|
+
]
|
|
65086
|
+
},
|
|
65087
|
+
{
|
|
65088
|
+
"type": "string",
|
|
65089
|
+
"enum": [
|
|
65090
|
+
"not_equals"
|
|
65091
|
+
]
|
|
65092
|
+
}
|
|
65093
|
+
]
|
|
65094
|
+
},
|
|
65095
|
+
"value": {
|
|
65096
|
+
"minLength": 1,
|
|
65097
|
+
"maxLength": 200,
|
|
65098
|
+
"type": "string"
|
|
65099
|
+
}
|
|
65100
|
+
}
|
|
65101
|
+
}
|
|
65102
|
+
]
|
|
65103
|
+
}
|
|
65104
|
+
}
|
|
65105
|
+
}
|
|
65106
|
+
}
|
|
65107
|
+
},
|
|
65108
|
+
"created_by": {
|
|
65109
|
+
"description": "Who saved it; null when that user no longer exists.",
|
|
65110
|
+
"anyOf": [
|
|
65111
|
+
{
|
|
65112
|
+
"format": "uuid",
|
|
65113
|
+
"type": "string"
|
|
65114
|
+
},
|
|
65115
|
+
{
|
|
65116
|
+
"type": "null"
|
|
65117
|
+
}
|
|
65118
|
+
]
|
|
65119
|
+
},
|
|
65120
|
+
"created_at": {
|
|
65121
|
+
"format": "date-time",
|
|
65122
|
+
"type": "string"
|
|
65123
|
+
}
|
|
65124
|
+
}
|
|
65125
|
+
}
|
|
65126
|
+
}
|
|
65127
|
+
}
|
|
65128
|
+
},
|
|
65129
|
+
"400": {
|
|
65130
|
+
"description": "Explicit destination workspace required: send the x-team-id header or activate a team scope for this operation.",
|
|
65131
|
+
"content": {
|
|
65132
|
+
"application/json": {
|
|
65133
|
+
"schema": {
|
|
65134
|
+
"description": "Explicit destination workspace required: send the x-team-id header or activate a team scope for this operation.",
|
|
65135
|
+
"additionalProperties": false,
|
|
65136
|
+
"type": "object",
|
|
65137
|
+
"required": [
|
|
65138
|
+
"statusCode",
|
|
65139
|
+
"error",
|
|
65140
|
+
"message"
|
|
65141
|
+
],
|
|
65142
|
+
"properties": {
|
|
65143
|
+
"statusCode": {
|
|
65144
|
+
"type": "number"
|
|
65145
|
+
},
|
|
65146
|
+
"error": {
|
|
65147
|
+
"type": "string"
|
|
65148
|
+
},
|
|
65149
|
+
"message": {
|
|
65150
|
+
"type": "string"
|
|
65151
|
+
},
|
|
65152
|
+
"code": {
|
|
65153
|
+
"description": "`SCOPE_TEAM_REQUIRED` when no destination workspace was given; a validation 400 keeps its own code (e.g. `FST_ERR_VALIDATION`).",
|
|
65154
|
+
"type": "string"
|
|
65155
|
+
}
|
|
65156
|
+
}
|
|
65157
|
+
}
|
|
65158
|
+
}
|
|
65159
|
+
}
|
|
65160
|
+
},
|
|
65161
|
+
"401": {
|
|
65162
|
+
"description": "Unauthorized - missing or invalid bearer token",
|
|
65163
|
+
"content": {
|
|
65164
|
+
"application/json": {
|
|
65165
|
+
"schema": {
|
|
65166
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
65167
|
+
}
|
|
65168
|
+
}
|
|
65169
|
+
}
|
|
65170
|
+
},
|
|
65171
|
+
"409": {
|
|
65172
|
+
"description": "FILTER_SET_NAME_TAKEN: the workspace already has a set with this name (case-insensitive). FILTER_SET_LIMIT_REACHED: the workspace already has 20 sets.",
|
|
65173
|
+
"content": {
|
|
65174
|
+
"application/json": {
|
|
65175
|
+
"schema": {
|
|
65176
|
+
"additionalProperties": false,
|
|
65177
|
+
"description": "FILTER_SET_NAME_TAKEN: the workspace already has a set with this name (case-insensitive). FILTER_SET_LIMIT_REACHED: the workspace already has 20 sets.",
|
|
65178
|
+
"type": "object",
|
|
65179
|
+
"required": [
|
|
65180
|
+
"error",
|
|
65181
|
+
"code"
|
|
65182
|
+
],
|
|
65183
|
+
"properties": {
|
|
65184
|
+
"error": {
|
|
65185
|
+
"type": "string"
|
|
65186
|
+
},
|
|
65187
|
+
"code": {
|
|
65188
|
+
"anyOf": [
|
|
65189
|
+
{
|
|
65190
|
+
"type": "string",
|
|
65191
|
+
"enum": [
|
|
65192
|
+
"FILTER_SET_NAME_TAKEN"
|
|
65193
|
+
]
|
|
65194
|
+
},
|
|
65195
|
+
{
|
|
65196
|
+
"type": "string",
|
|
65197
|
+
"enum": [
|
|
65198
|
+
"FILTER_SET_LIMIT_REACHED"
|
|
65199
|
+
]
|
|
65200
|
+
}
|
|
65201
|
+
]
|
|
65202
|
+
}
|
|
65203
|
+
}
|
|
65204
|
+
}
|
|
65205
|
+
}
|
|
65206
|
+
}
|
|
65207
|
+
},
|
|
65208
|
+
"503": {
|
|
65209
|
+
"description": "Session revocation check unavailable (Redis): retry after the Retry-After header.",
|
|
65210
|
+
"headers": {
|
|
65211
|
+
"Retry-After": {
|
|
65212
|
+
"description": "Seconds to wait before retrying the identical request.",
|
|
65213
|
+
"schema": {
|
|
65214
|
+
"type": "integer"
|
|
65215
|
+
}
|
|
65216
|
+
}
|
|
65217
|
+
},
|
|
65218
|
+
"content": {
|
|
65219
|
+
"application/json": {
|
|
65220
|
+
"schema": {
|
|
65221
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
65222
|
+
}
|
|
65223
|
+
}
|
|
65224
|
+
}
|
|
65225
|
+
}
|
|
65226
|
+
}
|
|
65227
|
+
}
|
|
65228
|
+
},
|
|
65229
|
+
"/api/v1/analytics/campaign-filter-sets/{id}": {
|
|
65230
|
+
"delete": {
|
|
65231
|
+
"operationId": "deleteAnalyticsCampaignFilterSet",
|
|
65232
|
+
"summary": "Delete a saved campaign filter set",
|
|
65233
|
+
"tags": [
|
|
65234
|
+
"analytics"
|
|
65235
|
+
],
|
|
65236
|
+
"description": "Deletes one set of the workspace for every member. 404 FILTER_SET_NOT_FOUND when the id is not a set of the workspace of the request.",
|
|
65237
|
+
"parameters": [
|
|
65238
|
+
{
|
|
65239
|
+
"schema": {
|
|
65240
|
+
"format": "uuid",
|
|
65241
|
+
"type": "string"
|
|
65242
|
+
},
|
|
65243
|
+
"in": "path",
|
|
65244
|
+
"name": "id",
|
|
65245
|
+
"required": true
|
|
65246
|
+
},
|
|
65247
|
+
{
|
|
65248
|
+
"schema": {
|
|
65249
|
+
"format": "uuid",
|
|
65250
|
+
"type": "string"
|
|
65251
|
+
},
|
|
65252
|
+
"in": "header",
|
|
65253
|
+
"name": "x-team-id",
|
|
65254
|
+
"required": false,
|
|
65255
|
+
"description": "Destination workspace team id."
|
|
65256
|
+
}
|
|
65257
|
+
],
|
|
65258
|
+
"security": [
|
|
65259
|
+
{
|
|
65260
|
+
"bearerAuth": []
|
|
65261
|
+
}
|
|
65262
|
+
],
|
|
65263
|
+
"responses": {
|
|
65264
|
+
"204": {
|
|
65265
|
+
"description": "Deleted."
|
|
65266
|
+
},
|
|
65267
|
+
"400": {
|
|
65268
|
+
"description": "Explicit destination workspace required: send the x-team-id header or activate a team scope for this operation.",
|
|
65269
|
+
"content": {
|
|
65270
|
+
"application/json": {
|
|
65271
|
+
"schema": {
|
|
65272
|
+
"description": "Explicit destination workspace required: send the x-team-id header or activate a team scope for this operation.",
|
|
65273
|
+
"additionalProperties": false,
|
|
65274
|
+
"type": "object",
|
|
65275
|
+
"required": [
|
|
65276
|
+
"statusCode",
|
|
65277
|
+
"error",
|
|
65278
|
+
"message"
|
|
65279
|
+
],
|
|
65280
|
+
"properties": {
|
|
65281
|
+
"statusCode": {
|
|
65282
|
+
"type": "number"
|
|
65283
|
+
},
|
|
65284
|
+
"error": {
|
|
65285
|
+
"type": "string"
|
|
65286
|
+
},
|
|
65287
|
+
"message": {
|
|
65288
|
+
"type": "string"
|
|
65289
|
+
},
|
|
65290
|
+
"code": {
|
|
65291
|
+
"description": "`SCOPE_TEAM_REQUIRED` when no destination workspace was given; a validation 400 keeps its own code (e.g. `FST_ERR_VALIDATION`).",
|
|
65292
|
+
"type": "string"
|
|
65293
|
+
}
|
|
65294
|
+
}
|
|
65295
|
+
}
|
|
65296
|
+
}
|
|
65297
|
+
}
|
|
65298
|
+
},
|
|
65299
|
+
"401": {
|
|
65300
|
+
"description": "Unauthorized - missing or invalid bearer token",
|
|
65301
|
+
"content": {
|
|
65302
|
+
"application/json": {
|
|
65303
|
+
"schema": {
|
|
65304
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
65305
|
+
}
|
|
65306
|
+
}
|
|
65307
|
+
}
|
|
65308
|
+
},
|
|
65309
|
+
"404": {
|
|
65310
|
+
"description": "No set with this id in the workspace of the request.",
|
|
65311
|
+
"content": {
|
|
65312
|
+
"application/json": {
|
|
65313
|
+
"schema": {
|
|
65314
|
+
"additionalProperties": false,
|
|
65315
|
+
"description": "No set with this id in the workspace of the request.",
|
|
65316
|
+
"type": "object",
|
|
65317
|
+
"required": [
|
|
65318
|
+
"error",
|
|
65319
|
+
"code"
|
|
65320
|
+
],
|
|
65321
|
+
"properties": {
|
|
65322
|
+
"error": {
|
|
65323
|
+
"type": "string"
|
|
65324
|
+
},
|
|
65325
|
+
"code": {
|
|
65326
|
+
"type": "string",
|
|
65327
|
+
"enum": [
|
|
65328
|
+
"FILTER_SET_NOT_FOUND"
|
|
65329
|
+
]
|
|
65330
|
+
}
|
|
65331
|
+
}
|
|
65332
|
+
}
|
|
65333
|
+
}
|
|
65334
|
+
}
|
|
65335
|
+
},
|
|
65336
|
+
"503": {
|
|
65337
|
+
"description": "Session revocation check unavailable (Redis): retry after the Retry-After header.",
|
|
65338
|
+
"headers": {
|
|
65339
|
+
"Retry-After": {
|
|
65340
|
+
"description": "Seconds to wait before retrying the identical request.",
|
|
65341
|
+
"schema": {
|
|
65342
|
+
"type": "integer"
|
|
65343
|
+
}
|
|
65344
|
+
}
|
|
65345
|
+
},
|
|
65346
|
+
"content": {
|
|
65347
|
+
"application/json": {
|
|
65348
|
+
"schema": {
|
|
65349
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
65350
|
+
}
|
|
65351
|
+
}
|
|
65352
|
+
}
|
|
65353
|
+
}
|
|
65354
|
+
}
|
|
65355
|
+
}
|
|
65356
|
+
},
|
|
63724
65357
|
"/api/v1/analytics/kpi": {
|
|
63725
65358
|
"get": {
|
|
63726
65359
|
"operationId": "getAnalyticsKpi",
|
|
@@ -86577,7 +88210,7 @@
|
|
|
86577
88210
|
"tags": [
|
|
86578
88211
|
"bigcommerce"
|
|
86579
88212
|
],
|
|
86580
|
-
"description": "Connects a BigCommerce store to the explicit destination workspace (x-team-id or active team scope) with a store-level API account: the store hash (or the API path) and the access token. The account needs three read-only scopes: Information & Settings, Orders, Products. The token is tried before anything is saved: 400 BIGCOMMERCE_TOKEN_REJECTED when BigCommerce refuses it (or the store hash does not exist), 400 BIGCOMMERCE_MISSING_SCOPES with the missing scopes.
|
|
88213
|
+
"description": "Connects a BigCommerce store to the explicit destination workspace (x-team-id or active team scope) with a store-level API account: the store hash (or the API path) and the access token. The account needs three read-only scopes: Information & Settings, Orders, Products. The token is tried before anything is saved: 400 BIGCOMMERCE_TOKEN_REJECTED when BigCommerce refuses it (or the store hash does not exist), 400 BIGCOMMERCE_MISSING_SCOPES with the missing scopes. The store rules of WooCommerce and PrestaShop apply (key = the store hash): a store held by another workspace of the organization answers 409 STORE_ALREADY_ASSIGNED, or 403 STORE_MOVE_FORBIDDEN without the role there (moving it is not offered yet); a second store on another registrable domain answers 409 STORE_SECOND_IN_WORKSPACE (the owner may answer store_relation=same_workspace for the same name on another extension); 409 BIGCOMMERCE_STORE_DOMAIN_UNKNOWN when BigCommerce gives no domain to compare. A store held by a workspace of another organization answers 409 BIGCOMMERCE_STORE_IN_ANOTHER_WORKSPACE. Connecting it again here replaces the token. A store new to the workspace counts against the catalog quota. The first sync (catalog and the orders of the last 7 days) is queued; new orders are read every 15 minutes. 503 FEATURE_DISABLED while the integration is off for the caller.",
|
|
86581
88214
|
"requestBody": {
|
|
86582
88215
|
"required": true,
|
|
86583
88216
|
"content": {
|
|
@@ -86601,6 +88234,26 @@
|
|
|
86601
88234
|
"maxLength": 200,
|
|
86602
88235
|
"description": "The access token of the API account.",
|
|
86603
88236
|
"type": "string"
|
|
88237
|
+
},
|
|
88238
|
+
"store_relation": {
|
|
88239
|
+
"description": "Without it, a store whose domain differs from the stores already in the destination workspace answers 409 STORE_SECOND_IN_WORKSPACE. Another workspace has no value here: connect the store to another workspace.",
|
|
88240
|
+
"anyOf": [
|
|
88241
|
+
{
|
|
88242
|
+
"description": "Regola B per dominio: the owner of the organization keeps the store in this workspace although its domain has the same name as a store already here on another extension (for example marchio.de next to marchio.it). Only the owner (or platform staff) can give it: anyone else gets 409 STORE_SECOND_IN_WORKSPACE with reason owner_required.",
|
|
88243
|
+
"type": "string",
|
|
88244
|
+
"enum": [
|
|
88245
|
+
"same_workspace"
|
|
88246
|
+
]
|
|
88247
|
+
},
|
|
88248
|
+
{
|
|
88249
|
+
"deprecated": true,
|
|
88250
|
+
"description": "Retired on 29/10/2026: answers 400 STORE_RELATION_RETIRED and connects nothing.",
|
|
88251
|
+
"type": "string",
|
|
88252
|
+
"enum": [
|
|
88253
|
+
"same_brand"
|
|
88254
|
+
]
|
|
88255
|
+
}
|
|
88256
|
+
]
|
|
86604
88257
|
}
|
|
86605
88258
|
}
|
|
86606
88259
|
}
|
|
@@ -86797,237 +88450,570 @@
|
|
|
86797
88450
|
}
|
|
86798
88451
|
}
|
|
86799
88452
|
}
|
|
86800
|
-
},
|
|
86801
|
-
{
|
|
86802
|
-
"
|
|
86803
|
-
"
|
|
86804
|
-
"type": "object",
|
|
86805
|
-
"required": [
|
|
86806
|
-
"statusCode",
|
|
86807
|
-
"error",
|
|
86808
|
-
"message"
|
|
86809
|
-
|
|
86810
|
-
|
|
86811
|
-
|
|
86812
|
-
|
|
86813
|
-
|
|
86814
|
-
|
|
86815
|
-
|
|
86816
|
-
|
|
86817
|
-
|
|
86818
|
-
|
|
86819
|
-
|
|
86820
|
-
|
|
86821
|
-
|
|
86822
|
-
"type": "string"
|
|
86823
|
-
|
|
86824
|
-
|
|
86825
|
-
|
|
86826
|
-
|
|
86827
|
-
|
|
86828
|
-
|
|
86829
|
-
|
|
86830
|
-
|
|
86831
|
-
|
|
86832
|
-
|
|
86833
|
-
|
|
86834
|
-
|
|
86835
|
-
|
|
86836
|
-
|
|
86837
|
-
|
|
86838
|
-
|
|
86839
|
-
|
|
86840
|
-
|
|
86841
|
-
|
|
86842
|
-
|
|
86843
|
-
|
|
86844
|
-
|
|
86845
|
-
|
|
86846
|
-
|
|
86847
|
-
|
|
86848
|
-
|
|
86849
|
-
|
|
86850
|
-
|
|
86851
|
-
|
|
86852
|
-
|
|
86853
|
-
|
|
86854
|
-
|
|
86855
|
-
|
|
86856
|
-
|
|
86857
|
-
|
|
86858
|
-
|
|
86859
|
-
|
|
86860
|
-
|
|
86861
|
-
|
|
86862
|
-
|
|
86863
|
-
|
|
86864
|
-
|
|
86865
|
-
|
|
86866
|
-
|
|
86867
|
-
|
|
86868
|
-
|
|
86869
|
-
|
|
86870
|
-
|
|
86871
|
-
|
|
86872
|
-
|
|
86873
|
-
|
|
86874
|
-
|
|
86875
|
-
|
|
86876
|
-
|
|
86877
|
-
|
|
86878
|
-
|
|
86879
|
-
|
|
86880
|
-
|
|
86881
|
-
|
|
86882
|
-
|
|
86883
|
-
|
|
86884
|
-
|
|
86885
|
-
|
|
86886
|
-
|
|
86887
|
-
|
|
86888
|
-
|
|
86889
|
-
|
|
86890
|
-
|
|
86891
|
-
|
|
86892
|
-
{
|
|
86893
|
-
"type": "
|
|
86894
|
-
|
|
86895
|
-
|
|
86896
|
-
|
|
86897
|
-
|
|
86898
|
-
|
|
86899
|
-
|
|
86900
|
-
|
|
86901
|
-
|
|
86902
|
-
|
|
86903
|
-
|
|
86904
|
-
|
|
86905
|
-
|
|
86906
|
-
|
|
86907
|
-
|
|
86908
|
-
|
|
86909
|
-
|
|
86910
|
-
|
|
86911
|
-
|
|
86912
|
-
|
|
86913
|
-
|
|
86914
|
-
|
|
86915
|
-
|
|
86916
|
-
|
|
86917
|
-
|
|
86918
|
-
|
|
86919
|
-
|
|
86920
|
-
|
|
86921
|
-
|
|
86922
|
-
|
|
86923
|
-
|
|
86924
|
-
|
|
86925
|
-
|
|
86926
|
-
|
|
86927
|
-
|
|
86928
|
-
|
|
86929
|
-
|
|
86930
|
-
|
|
86931
|
-
|
|
86932
|
-
|
|
86933
|
-
|
|
86934
|
-
|
|
86935
|
-
|
|
86936
|
-
|
|
86937
|
-
|
|
86938
|
-
|
|
86939
|
-
|
|
86940
|
-
|
|
86941
|
-
|
|
86942
|
-
|
|
86943
|
-
|
|
86944
|
-
|
|
86945
|
-
|
|
86946
|
-
|
|
86947
|
-
|
|
86948
|
-
|
|
86949
|
-
|
|
86950
|
-
|
|
86951
|
-
"
|
|
86952
|
-
|
|
86953
|
-
|
|
86954
|
-
"
|
|
86955
|
-
|
|
86956
|
-
|
|
86957
|
-
|
|
86958
|
-
|
|
86959
|
-
|
|
86960
|
-
|
|
86961
|
-
|
|
86962
|
-
|
|
86963
|
-
|
|
86964
|
-
|
|
86965
|
-
|
|
86966
|
-
|
|
86967
|
-
|
|
86968
|
-
|
|
86969
|
-
|
|
88453
|
+
},
|
|
88454
|
+
{
|
|
88455
|
+
"additionalProperties": false,
|
|
88456
|
+
"description": "store_relation=same_brand was retired on 29/10/2026: a workspace now holds the stores of one domain. Nothing was connected. Retry without it to read the answer for this store (409 STORE_SECOND_IN_WORKSPACE says what is possible).",
|
|
88457
|
+
"type": "object",
|
|
88458
|
+
"required": [
|
|
88459
|
+
"statusCode",
|
|
88460
|
+
"error",
|
|
88461
|
+
"message",
|
|
88462
|
+
"code"
|
|
88463
|
+
],
|
|
88464
|
+
"properties": {
|
|
88465
|
+
"statusCode": {
|
|
88466
|
+
"type": "number"
|
|
88467
|
+
},
|
|
88468
|
+
"error": {
|
|
88469
|
+
"type": "string"
|
|
88470
|
+
},
|
|
88471
|
+
"message": {
|
|
88472
|
+
"type": "string"
|
|
88473
|
+
},
|
|
88474
|
+
"code": {
|
|
88475
|
+
"type": "string",
|
|
88476
|
+
"enum": [
|
|
88477
|
+
"STORE_RELATION_RETIRED"
|
|
88478
|
+
]
|
|
88479
|
+
}
|
|
88480
|
+
}
|
|
88481
|
+
},
|
|
88482
|
+
{
|
|
88483
|
+
"description": "Explicit destination workspace required: send the x-team-id header or activate a team scope for this operation.",
|
|
88484
|
+
"additionalProperties": false,
|
|
88485
|
+
"type": "object",
|
|
88486
|
+
"required": [
|
|
88487
|
+
"statusCode",
|
|
88488
|
+
"error",
|
|
88489
|
+
"message"
|
|
88490
|
+
],
|
|
88491
|
+
"properties": {
|
|
88492
|
+
"statusCode": {
|
|
88493
|
+
"type": "number"
|
|
88494
|
+
},
|
|
88495
|
+
"error": {
|
|
88496
|
+
"type": "string"
|
|
88497
|
+
},
|
|
88498
|
+
"message": {
|
|
88499
|
+
"type": "string"
|
|
88500
|
+
},
|
|
88501
|
+
"code": {
|
|
88502
|
+
"description": "`SCOPE_TEAM_REQUIRED` when no destination workspace was given; a validation 400 keeps its own code (e.g. `FST_ERR_VALIDATION`).",
|
|
88503
|
+
"type": "string"
|
|
88504
|
+
}
|
|
88505
|
+
}
|
|
88506
|
+
}
|
|
88507
|
+
]
|
|
88508
|
+
}
|
|
88509
|
+
}
|
|
88510
|
+
}
|
|
88511
|
+
},
|
|
88512
|
+
"401": {
|
|
88513
|
+
"description": "Unauthorized - missing or invalid bearer token",
|
|
88514
|
+
"content": {
|
|
88515
|
+
"application/json": {
|
|
88516
|
+
"schema": {
|
|
88517
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
88518
|
+
}
|
|
88519
|
+
}
|
|
88520
|
+
}
|
|
88521
|
+
},
|
|
88522
|
+
"403": {
|
|
88523
|
+
"description": "Forbidden - caller lacks the required role/permission",
|
|
88524
|
+
"content": {
|
|
88525
|
+
"application/json": {
|
|
88526
|
+
"schema": {
|
|
88527
|
+
"anyOf": [
|
|
88528
|
+
{
|
|
88529
|
+
"additionalProperties": false,
|
|
88530
|
+
"description": "Forbidden. With `code: STORE_MOVE_FORBIDDEN`: the store (`store`) is already in another workspace of the organization where the caller cannot take stores out (manager or higher there, raised by the backoffice lever asset_permission_floors), or the caller is below the floor of connecting stores in this workspace. The workspace is not named and nothing moves, with or without confirm_move. With `code: ASSET_ROLE_FLOOR`: the caller's role here is below the floor of connecting stores (the code floor, raised by the backoffice lever asset_permission_floors). Other 403 bodies come from the role, plan and quota guards of the route.",
|
|
88531
|
+
"type": "object",
|
|
88532
|
+
"required": [
|
|
88533
|
+
"error"
|
|
88534
|
+
],
|
|
88535
|
+
"properties": {
|
|
88536
|
+
"statusCode": {
|
|
88537
|
+
"type": "number"
|
|
88538
|
+
},
|
|
88539
|
+
"error": {
|
|
88540
|
+
"type": "string"
|
|
88541
|
+
},
|
|
88542
|
+
"message": {
|
|
88543
|
+
"type": "string"
|
|
88544
|
+
},
|
|
88545
|
+
"code": {
|
|
88546
|
+
"type": "string"
|
|
88547
|
+
},
|
|
88548
|
+
"store": {
|
|
88549
|
+
"description": "With STORE_MOVE_FORBIDDEN: the store the request named (the shop or site domain).",
|
|
88550
|
+
"type": "string"
|
|
88551
|
+
}
|
|
88552
|
+
}
|
|
88553
|
+
},
|
|
88554
|
+
{
|
|
88555
|
+
"additionalProperties": false,
|
|
88556
|
+
"description": "Forbidden. With `code: ASSET_ROLE_FLOOR`: the caller's role in the workspace is below the floor for connecting this kind of asset here (`act: connect`) or for removing it from here (`act: disconnect`): the code floor, raised by the backoffice lever \"asset_permission_floors\".",
|
|
88557
|
+
"type": "object",
|
|
88558
|
+
"required": [
|
|
88559
|
+
"error"
|
|
88560
|
+
],
|
|
88561
|
+
"properties": {
|
|
88562
|
+
"statusCode": {
|
|
88563
|
+
"type": "number"
|
|
88564
|
+
},
|
|
88565
|
+
"error": {
|
|
88566
|
+
"type": "string"
|
|
88567
|
+
},
|
|
88568
|
+
"message": {
|
|
88569
|
+
"type": "string"
|
|
88570
|
+
},
|
|
88571
|
+
"code": {
|
|
88572
|
+
"type": "string"
|
|
88573
|
+
},
|
|
88574
|
+
"family": {
|
|
88575
|
+
"description": "With ASSET_ROLE_FLOOR: the asset family of the refused act.",
|
|
88576
|
+
"type": "string"
|
|
88577
|
+
},
|
|
88578
|
+
"act": {
|
|
88579
|
+
"description": "With ASSET_ROLE_FLOOR: connecting here, or removing from here.",
|
|
88580
|
+
"anyOf": [
|
|
88581
|
+
{
|
|
88582
|
+
"type": "string",
|
|
88583
|
+
"enum": [
|
|
88584
|
+
"connect"
|
|
88585
|
+
]
|
|
88586
|
+
},
|
|
88587
|
+
{
|
|
88588
|
+
"type": "string",
|
|
88589
|
+
"enum": [
|
|
88590
|
+
"disconnect"
|
|
88591
|
+
]
|
|
88592
|
+
}
|
|
88593
|
+
]
|
|
88594
|
+
}
|
|
88595
|
+
}
|
|
88596
|
+
},
|
|
88597
|
+
{
|
|
88598
|
+
"anyOf": [
|
|
88599
|
+
{
|
|
88600
|
+
"type": "object",
|
|
88601
|
+
"required": [
|
|
88602
|
+
"statusCode",
|
|
88603
|
+
"error",
|
|
88604
|
+
"message",
|
|
88605
|
+
"code",
|
|
88606
|
+
"resource",
|
|
88607
|
+
"current",
|
|
88608
|
+
"max",
|
|
88609
|
+
"plan"
|
|
88610
|
+
],
|
|
88611
|
+
"properties": {
|
|
88612
|
+
"statusCode": {
|
|
88613
|
+
"type": "number"
|
|
88614
|
+
},
|
|
88615
|
+
"error": {
|
|
88616
|
+
"type": "string"
|
|
88617
|
+
},
|
|
88618
|
+
"message": {
|
|
88619
|
+
"type": "string"
|
|
88620
|
+
},
|
|
88621
|
+
"code": {
|
|
88622
|
+
"type": "string"
|
|
88623
|
+
},
|
|
88624
|
+
"resource": {
|
|
88625
|
+
"type": "string"
|
|
88626
|
+
},
|
|
88627
|
+
"current": {
|
|
88628
|
+
"type": "number"
|
|
88629
|
+
},
|
|
88630
|
+
"max": {
|
|
88631
|
+
"type": "number"
|
|
88632
|
+
},
|
|
88633
|
+
"plan": {
|
|
88634
|
+
"type": "string"
|
|
88635
|
+
}
|
|
88636
|
+
}
|
|
88637
|
+
},
|
|
88638
|
+
{
|
|
88639
|
+
"type": "object",
|
|
88640
|
+
"required": [
|
|
88641
|
+
"statusCode",
|
|
88642
|
+
"error",
|
|
88643
|
+
"message"
|
|
88644
|
+
],
|
|
88645
|
+
"properties": {
|
|
88646
|
+
"statusCode": {
|
|
88647
|
+
"type": "integer"
|
|
88648
|
+
},
|
|
88649
|
+
"error": {
|
|
88650
|
+
"type": "string"
|
|
88651
|
+
},
|
|
88652
|
+
"message": {
|
|
88653
|
+
"type": "string"
|
|
88654
|
+
},
|
|
88655
|
+
"code": {
|
|
88656
|
+
"type": "string"
|
|
88657
|
+
},
|
|
88658
|
+
"status": {
|
|
88659
|
+
"type": "string"
|
|
88660
|
+
},
|
|
88661
|
+
"reason": {
|
|
88662
|
+
"anyOf": [
|
|
88663
|
+
{
|
|
88664
|
+
"type": "string"
|
|
88665
|
+
},
|
|
88666
|
+
{
|
|
88667
|
+
"type": "null"
|
|
88668
|
+
}
|
|
88669
|
+
]
|
|
88670
|
+
},
|
|
88671
|
+
"request_id": {
|
|
88672
|
+
"type": "string"
|
|
88673
|
+
}
|
|
88674
|
+
}
|
|
88675
|
+
}
|
|
88676
|
+
]
|
|
88677
|
+
}
|
|
88678
|
+
]
|
|
88679
|
+
}
|
|
88680
|
+
}
|
|
88681
|
+
}
|
|
88682
|
+
},
|
|
88683
|
+
"409": {
|
|
88684
|
+
"description": "Conflict - resource state prevents the operation",
|
|
88685
|
+
"content": {
|
|
88686
|
+
"application/json": {
|
|
88687
|
+
"schema": {
|
|
88688
|
+
"anyOf": [
|
|
88689
|
+
{
|
|
88690
|
+
"additionalProperties": false,
|
|
88691
|
+
"description": "The store is already connected to another workspace of your organization, where the caller can manage stores (manager or higher there, raised by the backoffice lever asset_permission_floors; otherwise the answer is 403 STORE_MOVE_FORBIDDEN and names no workspace). Retry with confirm_move=true to move it into the active workspace. In the other workspace the orders and the products of the store are removed. Here the catalog and a recent window of orders are synced again: older orders do not come back. The shipping, payment fee and extra costs declared on the store follow it, unless the store already has its own here; costs typed on single products do not.",
|
|
88692
|
+
"type": "object",
|
|
88693
|
+
"required": [
|
|
88694
|
+
"statusCode",
|
|
88695
|
+
"error",
|
|
88696
|
+
"message",
|
|
88697
|
+
"code",
|
|
88698
|
+
"current_team_id",
|
|
88699
|
+
"current_workspace_name",
|
|
88700
|
+
"platform",
|
|
88701
|
+
"store"
|
|
88702
|
+
],
|
|
88703
|
+
"properties": {
|
|
88704
|
+
"statusCode": {
|
|
88705
|
+
"type": "number"
|
|
88706
|
+
},
|
|
88707
|
+
"error": {
|
|
88708
|
+
"type": "string"
|
|
88709
|
+
},
|
|
88710
|
+
"message": {
|
|
88711
|
+
"type": "string"
|
|
88712
|
+
},
|
|
88713
|
+
"code": {
|
|
88714
|
+
"type": "string",
|
|
88715
|
+
"enum": [
|
|
88716
|
+
"STORE_ALREADY_ASSIGNED"
|
|
88717
|
+
]
|
|
88718
|
+
},
|
|
88719
|
+
"current_team_id": {
|
|
88720
|
+
"format": "uuid",
|
|
88721
|
+
"type": "string"
|
|
88722
|
+
},
|
|
88723
|
+
"current_workspace_name": {
|
|
88724
|
+
"anyOf": [
|
|
88725
|
+
{
|
|
88726
|
+
"type": "string"
|
|
88727
|
+
},
|
|
88728
|
+
{
|
|
88729
|
+
"type": "null"
|
|
88730
|
+
}
|
|
88731
|
+
]
|
|
88732
|
+
},
|
|
88733
|
+
"platform": {
|
|
88734
|
+
"anyOf": [
|
|
88735
|
+
{
|
|
88736
|
+
"type": "string",
|
|
88737
|
+
"enum": [
|
|
88738
|
+
"shopify"
|
|
88739
|
+
]
|
|
88740
|
+
},
|
|
88741
|
+
{
|
|
88742
|
+
"type": "string",
|
|
88743
|
+
"enum": [
|
|
88744
|
+
"woocommerce"
|
|
88745
|
+
]
|
|
88746
|
+
},
|
|
88747
|
+
{
|
|
88748
|
+
"type": "string",
|
|
88749
|
+
"enum": [
|
|
88750
|
+
"prestashop"
|
|
88751
|
+
]
|
|
88752
|
+
},
|
|
88753
|
+
{
|
|
88754
|
+
"type": "string",
|
|
88755
|
+
"enum": [
|
|
88756
|
+
"bigcommerce"
|
|
88757
|
+
]
|
|
88758
|
+
}
|
|
88759
|
+
]
|
|
88760
|
+
},
|
|
88761
|
+
"store": {
|
|
88762
|
+
"type": "string"
|
|
88763
|
+
}
|
|
88764
|
+
}
|
|
88765
|
+
},
|
|
88766
|
+
{
|
|
88767
|
+
"additionalProperties": false,
|
|
88768
|
+
"description": "The destination workspace already has stores, and a workspace holds the stores of one domain. reason=different_domain: the store has another name, it goes in another workspace of the organization (domain_workspace when one already has that domain and the caller can connect stores there, else a new one); no value of the body lets it in. reason=owner_choice: the same name on another extension (marchio.de next to marchio.it), the caller owns the organization: retry with store_relation=same_workspace to keep it here, or connect it to another workspace. reason=owner_required: the same case, but only the owner of the organization can choose: nothing lets the caller in.",
|
|
88769
|
+
"type": "object",
|
|
88770
|
+
"required": [
|
|
88771
|
+
"statusCode",
|
|
88772
|
+
"error",
|
|
88773
|
+
"message",
|
|
88774
|
+
"code",
|
|
88775
|
+
"reason",
|
|
88776
|
+
"choices",
|
|
88777
|
+
"domain_workspace",
|
|
88778
|
+
"existing_domain",
|
|
88779
|
+
"existing_platform",
|
|
88780
|
+
"existing_store",
|
|
88781
|
+
"organization_id",
|
|
88782
|
+
"platform",
|
|
88783
|
+
"store",
|
|
88784
|
+
"store_domain",
|
|
88785
|
+
"team_id",
|
|
88786
|
+
"workspace_name"
|
|
88787
|
+
],
|
|
88788
|
+
"properties": {
|
|
88789
|
+
"statusCode": {
|
|
88790
|
+
"type": "number"
|
|
88791
|
+
},
|
|
88792
|
+
"error": {
|
|
88793
|
+
"type": "string"
|
|
88794
|
+
},
|
|
88795
|
+
"message": {
|
|
88796
|
+
"type": "string"
|
|
88797
|
+
},
|
|
88798
|
+
"code": {
|
|
88799
|
+
"type": "string",
|
|
88800
|
+
"enum": [
|
|
88801
|
+
"STORE_SECOND_IN_WORKSPACE"
|
|
88802
|
+
]
|
|
88803
|
+
},
|
|
88804
|
+
"reason": {
|
|
88805
|
+
"anyOf": [
|
|
88806
|
+
{
|
|
88807
|
+
"type": "string",
|
|
88808
|
+
"enum": [
|
|
88809
|
+
"different_domain"
|
|
88810
|
+
]
|
|
88811
|
+
},
|
|
88812
|
+
{
|
|
88813
|
+
"type": "string",
|
|
88814
|
+
"enum": [
|
|
88815
|
+
"owner_choice"
|
|
88816
|
+
]
|
|
88817
|
+
},
|
|
88818
|
+
{
|
|
88819
|
+
"type": "string",
|
|
88820
|
+
"enum": [
|
|
88821
|
+
"owner_required"
|
|
88822
|
+
]
|
|
88823
|
+
}
|
|
88824
|
+
]
|
|
88825
|
+
},
|
|
88826
|
+
"choices": {
|
|
88827
|
+
"type": "array",
|
|
88828
|
+
"items": {
|
|
88829
|
+
"anyOf": [
|
|
88830
|
+
{
|
|
88831
|
+
"type": "string",
|
|
88832
|
+
"enum": [
|
|
88833
|
+
"same_workspace"
|
|
88834
|
+
]
|
|
88835
|
+
},
|
|
88836
|
+
{
|
|
88837
|
+
"type": "string",
|
|
88838
|
+
"enum": [
|
|
88839
|
+
"new_workspace"
|
|
88840
|
+
]
|
|
88841
|
+
}
|
|
88842
|
+
]
|
|
88843
|
+
}
|
|
88844
|
+
},
|
|
88845
|
+
"domain_workspace": {
|
|
88846
|
+
"anyOf": [
|
|
88847
|
+
{
|
|
88848
|
+
"additionalProperties": false,
|
|
88849
|
+
"type": "object",
|
|
88850
|
+
"required": [
|
|
88851
|
+
"team_id",
|
|
88852
|
+
"workspace_name"
|
|
88853
|
+
],
|
|
88854
|
+
"properties": {
|
|
88855
|
+
"team_id": {
|
|
88856
|
+
"format": "uuid",
|
|
88857
|
+
"type": "string"
|
|
88858
|
+
},
|
|
88859
|
+
"workspace_name": {
|
|
88860
|
+
"anyOf": [
|
|
88861
|
+
{
|
|
88862
|
+
"type": "string"
|
|
88863
|
+
},
|
|
88864
|
+
{
|
|
88865
|
+
"type": "null"
|
|
88866
|
+
}
|
|
88867
|
+
]
|
|
88868
|
+
}
|
|
88869
|
+
}
|
|
88870
|
+
},
|
|
88871
|
+
{
|
|
88872
|
+
"type": "null"
|
|
88873
|
+
}
|
|
88874
|
+
]
|
|
88875
|
+
},
|
|
88876
|
+
"existing_domain": {
|
|
88877
|
+
"type": "string"
|
|
88878
|
+
},
|
|
88879
|
+
"existing_platform": {
|
|
88880
|
+
"anyOf": [
|
|
88881
|
+
{
|
|
88882
|
+
"type": "string",
|
|
88883
|
+
"enum": [
|
|
88884
|
+
"shopify"
|
|
88885
|
+
]
|
|
88886
|
+
},
|
|
88887
|
+
{
|
|
88888
|
+
"type": "string",
|
|
88889
|
+
"enum": [
|
|
88890
|
+
"woocommerce"
|
|
88891
|
+
]
|
|
88892
|
+
},
|
|
88893
|
+
{
|
|
88894
|
+
"type": "string",
|
|
88895
|
+
"enum": [
|
|
88896
|
+
"prestashop"
|
|
88897
|
+
]
|
|
88898
|
+
},
|
|
88899
|
+
{
|
|
88900
|
+
"type": "string",
|
|
88901
|
+
"enum": [
|
|
88902
|
+
"bigcommerce"
|
|
88903
|
+
]
|
|
88904
|
+
}
|
|
88905
|
+
]
|
|
88906
|
+
},
|
|
88907
|
+
"existing_store": {
|
|
88908
|
+
"type": "string"
|
|
88909
|
+
},
|
|
88910
|
+
"organization_id": {
|
|
88911
|
+
"format": "uuid",
|
|
88912
|
+
"type": "string"
|
|
88913
|
+
},
|
|
88914
|
+
"platform": {
|
|
88915
|
+
"anyOf": [
|
|
88916
|
+
{
|
|
88917
|
+
"type": "string",
|
|
88918
|
+
"enum": [
|
|
88919
|
+
"shopify"
|
|
88920
|
+
]
|
|
88921
|
+
},
|
|
88922
|
+
{
|
|
88923
|
+
"type": "string",
|
|
88924
|
+
"enum": [
|
|
88925
|
+
"woocommerce"
|
|
88926
|
+
]
|
|
88927
|
+
},
|
|
88928
|
+
{
|
|
88929
|
+
"type": "string",
|
|
88930
|
+
"enum": [
|
|
88931
|
+
"prestashop"
|
|
88932
|
+
]
|
|
88933
|
+
},
|
|
88934
|
+
{
|
|
88935
|
+
"type": "string",
|
|
88936
|
+
"enum": [
|
|
88937
|
+
"bigcommerce"
|
|
88938
|
+
]
|
|
88939
|
+
}
|
|
88940
|
+
]
|
|
88941
|
+
},
|
|
88942
|
+
"store": {
|
|
88943
|
+
"type": "string"
|
|
88944
|
+
},
|
|
88945
|
+
"store_domain": {
|
|
88946
|
+
"type": "string"
|
|
88947
|
+
},
|
|
88948
|
+
"team_id": {
|
|
88949
|
+
"format": "uuid",
|
|
88950
|
+
"type": "string"
|
|
88951
|
+
},
|
|
88952
|
+
"workspace_name": {
|
|
88953
|
+
"anyOf": [
|
|
88954
|
+
{
|
|
88955
|
+
"type": "string"
|
|
88956
|
+
},
|
|
88957
|
+
{
|
|
88958
|
+
"type": "null"
|
|
88959
|
+
}
|
|
88960
|
+
]
|
|
88961
|
+
}
|
|
88962
|
+
}
|
|
88963
|
+
},
|
|
88964
|
+
{
|
|
88965
|
+
"additionalProperties": false,
|
|
88966
|
+
"type": "object",
|
|
88967
|
+
"required": [
|
|
88968
|
+
"error"
|
|
88969
|
+
],
|
|
88970
|
+
"properties": {
|
|
88971
|
+
"error": {
|
|
88972
|
+
"type": "string"
|
|
88973
|
+
},
|
|
88974
|
+
"code": {
|
|
88975
|
+
"type": "string"
|
|
88976
|
+
},
|
|
88977
|
+
"missing_scopes": {
|
|
88978
|
+
"description": "Read-only scopes the API account lacks (BIGCOMMERCE_MISSING_SCOPES).",
|
|
88979
|
+
"type": "array",
|
|
88980
|
+
"items": {
|
|
88981
|
+
"type": "string"
|
|
88982
|
+
}
|
|
88983
|
+
},
|
|
88984
|
+
"stores": {
|
|
88985
|
+
"description": "The stores of the workspace, when several and none named (STORE_REQUIRED).",
|
|
88986
|
+
"type": "array",
|
|
88987
|
+
"items": {
|
|
88988
|
+
"type": "object",
|
|
88989
|
+
"required": [
|
|
88990
|
+
"id",
|
|
88991
|
+
"store_name"
|
|
88992
|
+
],
|
|
88993
|
+
"properties": {
|
|
88994
|
+
"id": {
|
|
88995
|
+
"type": "string"
|
|
88996
|
+
},
|
|
88997
|
+
"store_name": {
|
|
88998
|
+
"anyOf": [
|
|
88999
|
+
{
|
|
89000
|
+
"type": "string"
|
|
89001
|
+
},
|
|
89002
|
+
{
|
|
89003
|
+
"type": "null"
|
|
89004
|
+
}
|
|
89005
|
+
]
|
|
89006
|
+
}
|
|
89007
|
+
}
|
|
89008
|
+
}
|
|
89009
|
+
}
|
|
89010
|
+
}
|
|
86970
89011
|
}
|
|
86971
89012
|
]
|
|
86972
89013
|
}
|
|
86973
89014
|
}
|
|
86974
89015
|
}
|
|
86975
89016
|
},
|
|
86976
|
-
"409": {
|
|
86977
|
-
"description": "Conflict - resource state prevents the operation",
|
|
86978
|
-
"content": {
|
|
86979
|
-
"application/json": {
|
|
86980
|
-
"schema": {
|
|
86981
|
-
"additionalProperties": false,
|
|
86982
|
-
"type": "object",
|
|
86983
|
-
"required": [
|
|
86984
|
-
"error"
|
|
86985
|
-
],
|
|
86986
|
-
"properties": {
|
|
86987
|
-
"error": {
|
|
86988
|
-
"type": "string"
|
|
86989
|
-
},
|
|
86990
|
-
"code": {
|
|
86991
|
-
"type": "string"
|
|
86992
|
-
},
|
|
86993
|
-
"missing_scopes": {
|
|
86994
|
-
"description": "Read-only scopes the API account lacks (BIGCOMMERCE_MISSING_SCOPES).",
|
|
86995
|
-
"type": "array",
|
|
86996
|
-
"items": {
|
|
86997
|
-
"type": "string"
|
|
86998
|
-
}
|
|
86999
|
-
},
|
|
87000
|
-
"stores": {
|
|
87001
|
-
"description": "The stores of the workspace, when several and none named (STORE_REQUIRED).",
|
|
87002
|
-
"type": "array",
|
|
87003
|
-
"items": {
|
|
87004
|
-
"type": "object",
|
|
87005
|
-
"required": [
|
|
87006
|
-
"id",
|
|
87007
|
-
"store_name"
|
|
87008
|
-
],
|
|
87009
|
-
"properties": {
|
|
87010
|
-
"id": {
|
|
87011
|
-
"type": "string"
|
|
87012
|
-
},
|
|
87013
|
-
"store_name": {
|
|
87014
|
-
"anyOf": [
|
|
87015
|
-
{
|
|
87016
|
-
"type": "string"
|
|
87017
|
-
},
|
|
87018
|
-
{
|
|
87019
|
-
"type": "null"
|
|
87020
|
-
}
|
|
87021
|
-
]
|
|
87022
|
-
}
|
|
87023
|
-
}
|
|
87024
|
-
}
|
|
87025
|
-
}
|
|
87026
|
-
}
|
|
87027
|
-
}
|
|
87028
|
-
}
|
|
87029
|
-
}
|
|
87030
|
-
},
|
|
87031
89017
|
"502": {
|
|
87032
89018
|
"description": "Bad gateway - upstream provider failed",
|
|
87033
89019
|
"content": {
|
|
@@ -161097,11 +163083,11 @@
|
|
|
161097
163083
|
"/api/v1/commerce/customers/new": {
|
|
161098
163084
|
"get": {
|
|
161099
163085
|
"operationId": "getCommerceNewCustomers",
|
|
161100
|
-
"summary": "New customers per day
|
|
163086
|
+
"summary": "New and returning customers per day for the team",
|
|
161101
163087
|
"tags": [
|
|
161102
163088
|
"commerce"
|
|
161103
163089
|
],
|
|
161104
|
-
"description": "
|
|
163090
|
+
"description": "Splits the customers who ordered in the requested range (UTC days, both ends included) into new ones, whose first recorded order ever is in the range, and returning ones, who had ordered before `from`. Each customer counts once, on the day of their first order of the range. Customers are matched by email across the stores of the team (only orders with an email count), optionally filtered to one connected store, with the same order population as the KPI cards. `history_from` says how far back the imported orders go.",
|
|
161105
163091
|
"parameters": [
|
|
161106
163092
|
{
|
|
161107
163093
|
"schema": {
|
|
@@ -161147,7 +163133,8 @@
|
|
|
161147
163133
|
"schema": {
|
|
161148
163134
|
"type": "object",
|
|
161149
163135
|
"required": [
|
|
161150
|
-
"items"
|
|
163136
|
+
"items",
|
|
163137
|
+
"history_from"
|
|
161151
163138
|
],
|
|
161152
163139
|
"properties": {
|
|
161153
163140
|
"items": {
|
|
@@ -161156,17 +163143,36 @@
|
|
|
161156
163143
|
"type": "object",
|
|
161157
163144
|
"required": [
|
|
161158
163145
|
"date",
|
|
161159
|
-
"new_customers"
|
|
163146
|
+
"new_customers",
|
|
163147
|
+
"returning_customers"
|
|
161160
163148
|
],
|
|
161161
163149
|
"properties": {
|
|
161162
163150
|
"date": {
|
|
163151
|
+
"description": "UTC day, YYYY-MM-DD.",
|
|
161163
163152
|
"type": "string"
|
|
161164
163153
|
},
|
|
161165
163154
|
"new_customers": {
|
|
163155
|
+
"description": "Customers whose first order ever falls on this day (the first order inside the range).",
|
|
163156
|
+
"type": "integer"
|
|
163157
|
+
},
|
|
163158
|
+
"returning_customers": {
|
|
163159
|
+
"description": "Customers whose first order of the range falls on this day and whose first order ever is before `from`. A customer is in one day and one group only, so the days add up to the range.",
|
|
161166
163160
|
"type": "integer"
|
|
161167
163161
|
}
|
|
161168
163162
|
}
|
|
161169
163163
|
}
|
|
163164
|
+
},
|
|
163165
|
+
"history_from": {
|
|
163166
|
+
"description": "Day of the oldest order the history holds (UTC). A customer whose earlier orders are older than the imported history counts as new: the store connection imports a limited window.",
|
|
163167
|
+
"anyOf": [
|
|
163168
|
+
{
|
|
163169
|
+
"format": "date",
|
|
163170
|
+
"type": "string"
|
|
163171
|
+
},
|
|
163172
|
+
{
|
|
163173
|
+
"type": "null"
|
|
163174
|
+
}
|
|
163175
|
+
]
|
|
161170
163176
|
}
|
|
161171
163177
|
}
|
|
161172
163178
|
}
|
|
@@ -162223,6 +164229,7 @@
|
|
|
162223
164229
|
"attribution_rate_pct",
|
|
162224
164230
|
"avg_order_value",
|
|
162225
164231
|
"avg_profit_margin_pct",
|
|
164232
|
+
"session_days",
|
|
162226
164233
|
"total_sessions",
|
|
162227
164234
|
"total_sessions_added_to_cart",
|
|
162228
164235
|
"total_sessions_reached_checkout",
|
|
@@ -162318,6 +164325,11 @@
|
|
|
162318
164325
|
}
|
|
162319
164326
|
]
|
|
162320
164327
|
},
|
|
164328
|
+
"session_days": {
|
|
164329
|
+
"minimum": 0,
|
|
164330
|
+
"description": "Days of the range with collected storefront sessions (Shopify sessions report). 0 means none collected yet, so the session totals are 0 without meaning that the store had no visits.",
|
|
164331
|
+
"type": "integer"
|
|
164332
|
+
},
|
|
162321
164333
|
"total_sessions": {
|
|
162322
164334
|
"type": "number"
|
|
162323
164335
|
},
|
|
@@ -267182,11 +269194,11 @@
|
|
|
267182
269194
|
"/api/v1/dashboard/hourly-stats": {
|
|
267183
269195
|
"get": {
|
|
267184
269196
|
"operationId": "getHourlyStats",
|
|
267185
|
-
"summary": "Get
|
|
269197
|
+
"summary": "Get daily spend totals in a chosen timezone",
|
|
267186
269198
|
"tags": [
|
|
267187
269199
|
"dashboard"
|
|
267188
269200
|
],
|
|
267189
|
-
"description": "Returns
|
|
269201
|
+
"description": "Returns one row per day (spend, impressions, clicks) for the date range, summed across the user's campaigns. The daily totals are computed from hourly records: by default each day follows the ad account's own timezone, and an IANA timezone moves every hour into that timezone before it is assigned to a day. Per-hour rows are not returned.",
|
|
267190
269202
|
"parameters": [
|
|
267191
269203
|
{
|
|
267192
269204
|
"schema": {
|
|
@@ -318698,6 +320710,12 @@
|
|
|
318698
320710
|
"enum": [
|
|
318699
320711
|
"prestashop"
|
|
318700
320712
|
]
|
|
320713
|
+
},
|
|
320714
|
+
{
|
|
320715
|
+
"type": "string",
|
|
320716
|
+
"enum": [
|
|
320717
|
+
"bigcommerce"
|
|
320718
|
+
]
|
|
318701
320719
|
}
|
|
318702
320720
|
]
|
|
318703
320721
|
},
|
|
@@ -318838,6 +320856,12 @@
|
|
|
318838
320856
|
"enum": [
|
|
318839
320857
|
"prestashop"
|
|
318840
320858
|
]
|
|
320859
|
+
},
|
|
320860
|
+
{
|
|
320861
|
+
"type": "string",
|
|
320862
|
+
"enum": [
|
|
320863
|
+
"bigcommerce"
|
|
320864
|
+
]
|
|
318841
320865
|
}
|
|
318842
320866
|
]
|
|
318843
320867
|
},
|
|
@@ -318867,6 +320891,12 @@
|
|
|
318867
320891
|
"enum": [
|
|
318868
320892
|
"prestashop"
|
|
318869
320893
|
]
|
|
320894
|
+
},
|
|
320895
|
+
{
|
|
320896
|
+
"type": "string",
|
|
320897
|
+
"enum": [
|
|
320898
|
+
"bigcommerce"
|
|
320899
|
+
]
|
|
318870
320900
|
}
|
|
318871
320901
|
]
|
|
318872
320902
|
},
|
|
@@ -420766,6 +422796,12 @@
|
|
|
420766
422796
|
"enum": [
|
|
420767
422797
|
"prestashop"
|
|
420768
422798
|
]
|
|
422799
|
+
},
|
|
422800
|
+
{
|
|
422801
|
+
"type": "string",
|
|
422802
|
+
"enum": [
|
|
422803
|
+
"bigcommerce"
|
|
422804
|
+
]
|
|
420769
422805
|
}
|
|
420770
422806
|
]
|
|
420771
422807
|
},
|
|
@@ -420938,6 +422974,12 @@
|
|
|
420938
422974
|
"enum": [
|
|
420939
422975
|
"prestashop"
|
|
420940
422976
|
]
|
|
422977
|
+
},
|
|
422978
|
+
{
|
|
422979
|
+
"type": "string",
|
|
422980
|
+
"enum": [
|
|
422981
|
+
"bigcommerce"
|
|
422982
|
+
]
|
|
420941
422983
|
}
|
|
420942
422984
|
]
|
|
420943
422985
|
},
|
|
@@ -420967,6 +423009,12 @@
|
|
|
420967
423009
|
"enum": [
|
|
420968
423010
|
"prestashop"
|
|
420969
423011
|
]
|
|
423012
|
+
},
|
|
423013
|
+
{
|
|
423014
|
+
"type": "string",
|
|
423015
|
+
"enum": [
|
|
423016
|
+
"bigcommerce"
|
|
423017
|
+
]
|
|
420970
423018
|
}
|
|
420971
423019
|
]
|
|
420972
423020
|
},
|
|
@@ -421346,6 +423394,12 @@
|
|
|
421346
423394
|
"enum": [
|
|
421347
423395
|
"prestashop"
|
|
421348
423396
|
]
|
|
423397
|
+
},
|
|
423398
|
+
{
|
|
423399
|
+
"type": "string",
|
|
423400
|
+
"enum": [
|
|
423401
|
+
"bigcommerce"
|
|
423402
|
+
]
|
|
421349
423403
|
}
|
|
421350
423404
|
]
|
|
421351
423405
|
},
|
|
@@ -421518,6 +423572,12 @@
|
|
|
421518
423572
|
"enum": [
|
|
421519
423573
|
"prestashop"
|
|
421520
423574
|
]
|
|
423575
|
+
},
|
|
423576
|
+
{
|
|
423577
|
+
"type": "string",
|
|
423578
|
+
"enum": [
|
|
423579
|
+
"bigcommerce"
|
|
423580
|
+
]
|
|
421521
423581
|
}
|
|
421522
423582
|
]
|
|
421523
423583
|
},
|
|
@@ -421547,6 +423607,12 @@
|
|
|
421547
423607
|
"enum": [
|
|
421548
423608
|
"prestashop"
|
|
421549
423609
|
]
|
|
423610
|
+
},
|
|
423611
|
+
{
|
|
423612
|
+
"type": "string",
|
|
423613
|
+
"enum": [
|
|
423614
|
+
"bigcommerce"
|
|
423615
|
+
]
|
|
421550
423616
|
}
|
|
421551
423617
|
]
|
|
421552
423618
|
},
|
|
@@ -424397,6 +426463,12 @@
|
|
|
424397
426463
|
"enum": [
|
|
424398
426464
|
"prestashop"
|
|
424399
426465
|
]
|
|
426466
|
+
},
|
|
426467
|
+
{
|
|
426468
|
+
"type": "string",
|
|
426469
|
+
"enum": [
|
|
426470
|
+
"bigcommerce"
|
|
426471
|
+
]
|
|
424400
426472
|
}
|
|
424401
426473
|
]
|
|
424402
426474
|
},
|
|
@@ -424537,6 +426609,12 @@
|
|
|
424537
426609
|
"enum": [
|
|
424538
426610
|
"prestashop"
|
|
424539
426611
|
]
|
|
426612
|
+
},
|
|
426613
|
+
{
|
|
426614
|
+
"type": "string",
|
|
426615
|
+
"enum": [
|
|
426616
|
+
"bigcommerce"
|
|
426617
|
+
]
|
|
424540
426618
|
}
|
|
424541
426619
|
]
|
|
424542
426620
|
},
|
|
@@ -424566,6 +426644,12 @@
|
|
|
424566
426644
|
"enum": [
|
|
424567
426645
|
"prestashop"
|
|
424568
426646
|
]
|
|
426647
|
+
},
|
|
426648
|
+
{
|
|
426649
|
+
"type": "string",
|
|
426650
|
+
"enum": [
|
|
426651
|
+
"bigcommerce"
|
|
426652
|
+
]
|
|
424569
426653
|
}
|
|
424570
426654
|
]
|
|
424571
426655
|
},
|
|
@@ -536899,6 +538983,12 @@
|
|
|
536899
538983
|
"enum": [
|
|
536900
538984
|
"prestashop"
|
|
536901
538985
|
]
|
|
538986
|
+
},
|
|
538987
|
+
{
|
|
538988
|
+
"type": "string",
|
|
538989
|
+
"enum": [
|
|
538990
|
+
"bigcommerce"
|
|
538991
|
+
]
|
|
536902
538992
|
}
|
|
536903
538993
|
]
|
|
536904
538994
|
},
|
|
@@ -537039,6 +539129,12 @@
|
|
|
537039
539129
|
"enum": [
|
|
537040
539130
|
"prestashop"
|
|
537041
539131
|
]
|
|
539132
|
+
},
|
|
539133
|
+
{
|
|
539134
|
+
"type": "string",
|
|
539135
|
+
"enum": [
|
|
539136
|
+
"bigcommerce"
|
|
539137
|
+
]
|
|
537042
539138
|
}
|
|
537043
539139
|
]
|
|
537044
539140
|
},
|
|
@@ -537068,6 +539164,12 @@
|
|
|
537068
539164
|
"enum": [
|
|
537069
539165
|
"prestashop"
|
|
537070
539166
|
]
|
|
539167
|
+
},
|
|
539168
|
+
{
|
|
539169
|
+
"type": "string",
|
|
539170
|
+
"enum": [
|
|
539171
|
+
"bigcommerce"
|
|
539172
|
+
]
|
|
537071
539173
|
}
|
|
537072
539174
|
]
|
|
537073
539175
|
},
|
|
@@ -537317,6 +539419,12 @@
|
|
|
537317
539419
|
"enum": [
|
|
537318
539420
|
"prestashop"
|
|
537319
539421
|
]
|
|
539422
|
+
},
|
|
539423
|
+
{
|
|
539424
|
+
"type": "string",
|
|
539425
|
+
"enum": [
|
|
539426
|
+
"bigcommerce"
|
|
539427
|
+
]
|
|
537320
539428
|
}
|
|
537321
539429
|
]
|
|
537322
539430
|
},
|
|
@@ -537457,6 +539565,12 @@
|
|
|
537457
539565
|
"enum": [
|
|
537458
539566
|
"prestashop"
|
|
537459
539567
|
]
|
|
539568
|
+
},
|
|
539569
|
+
{
|
|
539570
|
+
"type": "string",
|
|
539571
|
+
"enum": [
|
|
539572
|
+
"bigcommerce"
|
|
539573
|
+
]
|
|
537460
539574
|
}
|
|
537461
539575
|
]
|
|
537462
539576
|
},
|
|
@@ -537486,6 +539600,12 @@
|
|
|
537486
539600
|
"enum": [
|
|
537487
539601
|
"prestashop"
|
|
537488
539602
|
]
|
|
539603
|
+
},
|
|
539604
|
+
{
|
|
539605
|
+
"type": "string",
|
|
539606
|
+
"enum": [
|
|
539607
|
+
"bigcommerce"
|
|
539608
|
+
]
|
|
537489
539609
|
}
|
|
537490
539610
|
]
|
|
537491
539611
|
},
|
|
@@ -537959,6 +540079,12 @@
|
|
|
537959
540079
|
"enum": [
|
|
537960
540080
|
"prestashop"
|
|
537961
540081
|
]
|
|
540082
|
+
},
|
|
540083
|
+
{
|
|
540084
|
+
"type": "string",
|
|
540085
|
+
"enum": [
|
|
540086
|
+
"bigcommerce"
|
|
540087
|
+
]
|
|
537962
540088
|
}
|
|
537963
540089
|
]
|
|
537964
540090
|
},
|
|
@@ -538099,6 +540225,12 @@
|
|
|
538099
540225
|
"enum": [
|
|
538100
540226
|
"prestashop"
|
|
538101
540227
|
]
|
|
540228
|
+
},
|
|
540229
|
+
{
|
|
540230
|
+
"type": "string",
|
|
540231
|
+
"enum": [
|
|
540232
|
+
"bigcommerce"
|
|
540233
|
+
]
|
|
538102
540234
|
}
|
|
538103
540235
|
]
|
|
538104
540236
|
},
|
|
@@ -538128,6 +540260,12 @@
|
|
|
538128
540260
|
"enum": [
|
|
538129
540261
|
"prestashop"
|
|
538130
540262
|
]
|
|
540263
|
+
},
|
|
540264
|
+
{
|
|
540265
|
+
"type": "string",
|
|
540266
|
+
"enum": [
|
|
540267
|
+
"bigcommerce"
|
|
540268
|
+
]
|
|
538131
540269
|
}
|
|
538132
540270
|
]
|
|
538133
540271
|
},
|