@atelier201/cli 0.15.0 → 0.16.0

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.
@@ -7220,7 +7220,7 @@ export const API_OPERATIONS = [
7220
7220
  "method": "GET",
7221
7221
  "path": "/v1/sites/{site_id}/analytics",
7222
7222
  "summary": "Read a site's visitor numbers",
7223
- "description": "Page views of the live site by people, with pages, sources, countries and devices, over a period (a preset, or from and to). No credits. Visitor figures are null when the owner turned visitor counting off, which only the owner can change, in the dashboard.",
7223
+ "description": "Page views of the live site by people, with pages, sources, countries and devices, over a period (a preset, or from and to). With filter, one channel, assistant, source, page, country or device and where its views went (the pages people from ChatGPT landed on). No credits. Visitor figures are null when the owner turned visitor counting off, which only the owner can change, in the dashboard.",
7224
7224
  "authentication_required": true,
7225
7225
  "scope": "sites:read",
7226
7226
  "surfaces": {
@@ -7272,6 +7272,26 @@ export const API_OPERATIONS = [
7272
7272
  "type": "string",
7273
7273
  "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
7274
7274
  }
7275
+ },
7276
+ {
7277
+ "name": "sections",
7278
+ "in": "query",
7279
+ "required": false,
7280
+ "schema": {
7281
+ "description": "Only these parts besides the totals, comma-separated: series, pages, sources, channels, assistants, countries, devices, browsers, os, robots, markdown, not_found, forms. robots also brings bot_views. Leave it out for everything. A smaller answer costs less context.",
7282
+ "type": "string",
7283
+ "maxLength": 200
7284
+ }
7285
+ },
7286
+ {
7287
+ "name": "filter",
7288
+ "in": "query",
7289
+ "required": false,
7290
+ "schema": {
7291
+ "description": "Only the views of one channel, assistant, source, page, country or device, as dimension:value, e.g. assistant:ChatGPT, channel:ai, source:google.com, page:/menu, country:FR, device:mobile. The other breakdowns then show where those views went: the pages people from ChatGPT arrived on, the countries that read the menu. Covers the last 85 days. With a filter only series, pages, sources, channels, assistants, countries and devices come back, and visits and form sends are null.",
7292
+ "type": "string",
7293
+ "maxLength": 220
7294
+ }
7275
7295
  }
7276
7296
  ],
7277
7297
  "request_body": null,
@@ -7287,6 +7307,36 @@ export const API_OPERATIONS = [
7287
7307
  "$schema": "https://json-schema.org/draft/2020-12/schema",
7288
7308
  "type": "object",
7289
7309
  "properties": {
7310
+ "filter": {
7311
+ "description": "Present when the answer is filtered: every figure below is about those views only.",
7312
+ "type": "object",
7313
+ "properties": {
7314
+ "dimension": {
7315
+ "type": "string",
7316
+ "enum": [
7317
+ "channel",
7318
+ "assistant",
7319
+ "source",
7320
+ "page",
7321
+ "country",
7322
+ "device"
7323
+ ]
7324
+ },
7325
+ "value": {
7326
+ "type": "string"
7327
+ },
7328
+ "arrivals_only": {
7329
+ "type": "boolean",
7330
+ "description": "True for a channel, assistant or source: only the views people ARRIVED on are theirs, so pages are the pages they landed on, not every page they read after."
7331
+ }
7332
+ },
7333
+ "required": [
7334
+ "dimension",
7335
+ "value",
7336
+ "arrivals_only"
7337
+ ],
7338
+ "additionalProperties": false
7339
+ },
7290
7340
  "period": {
7291
7341
  "type": "string",
7292
7342
  "enum": [
@@ -7349,8 +7399,11 @@ export const API_OPERATIONS = [
7349
7399
  ]
7350
7400
  },
7351
7401
  "form_sends": {
7352
- "type": "number",
7353
- "description": "Form sends the site kept, spam aside. Counted on every site: a send carries no visitor hash."
7402
+ "description": "Form sends the site kept, spam aside. Counted on every site: a send carries no visitor hash. Null with a filter.",
7403
+ "type": [
7404
+ "number",
7405
+ "null"
7406
+ ]
7354
7407
  }
7355
7408
  },
7356
7409
  "required": [
@@ -7404,8 +7457,11 @@ export const API_OPERATIONS = [
7404
7457
  ]
7405
7458
  },
7406
7459
  "form_sends": {
7407
- "type": "number",
7408
- "description": "Form sends the site kept, spam aside. Counted on every site: a send carries no visitor hash."
7460
+ "description": "Form sends the site kept, spam aside. Counted on every site: a send carries no visitor hash. Null with a filter.",
7461
+ "type": [
7462
+ "number",
7463
+ "null"
7464
+ ]
7409
7465
  }
7410
7466
  },
7411
7467
  "required": [
@@ -7866,20 +7922,6 @@ export const API_OPERATIONS = [
7866
7922
  "visitor_counting",
7867
7923
  "totals",
7868
7924
  "previous",
7869
- "series",
7870
- "pages",
7871
- "sources",
7872
- "channels",
7873
- "assistants",
7874
- "countries",
7875
- "devices",
7876
- "browsers",
7877
- "os",
7878
- "bot_views",
7879
- "bots",
7880
- "markdown",
7881
- "not_found",
7882
- "forms",
7883
7925
  "updated_at"
7884
7926
  ],
7885
7927
  "additionalProperties": false
@@ -7934,6 +7976,368 @@ export const API_OPERATIONS = [
7934
7976
  }
7935
7977
  }
7936
7978
  },
7979
+ {
7980
+ "operation_id": "getWorkspaceAnalytics",
7981
+ "method": "GET",
7982
+ "path": "/v1/analytics",
7983
+ "summary": "Read every site's visitor numbers",
7984
+ "description": "One row per site of the workspace over a period: views, visitors, form sends, the period before, and the leading page, channel and AI assistant. Live sites first. No credits. For one site's detail, getSiteAnalytics.",
7985
+ "authentication_required": true,
7986
+ "scope": "sites:read",
7987
+ "surfaces": {
7988
+ "cli": "atelier201 analytics --all",
7989
+ "mcp": "get_workspace_analytics"
7990
+ },
7991
+ "parameters": [
7992
+ {
7993
+ "name": "period",
7994
+ "in": "query",
7995
+ "required": false,
7996
+ "schema": {
7997
+ "description": "today, 7d, 30d, 90d or 12m, ending today. Default 30d. Leave it out when you give from and to.",
7998
+ "type": "string",
7999
+ "enum": [
8000
+ "today",
8001
+ "7d",
8002
+ "30d",
8003
+ "90d",
8004
+ "12m"
8005
+ ]
8006
+ }
8007
+ },
8008
+ {
8009
+ "name": "from",
8010
+ "in": "query",
8011
+ "required": false,
8012
+ "schema": {
8013
+ "description": "First UTC day of a range of your own, YYYY-MM-DD, with to. At most 366 days.",
8014
+ "type": "string",
8015
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
8016
+ }
8017
+ },
8018
+ {
8019
+ "name": "to",
8020
+ "in": "query",
8021
+ "required": false,
8022
+ "schema": {
8023
+ "description": "Last UTC day of the range, YYYY-MM-DD, today at the latest.",
8024
+ "type": "string",
8025
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
8026
+ }
8027
+ }
8028
+ ],
8029
+ "request_body": null,
8030
+ "responses": {
8031
+ "200": {
8032
+ "description": "Read every site's visitor numbers",
8033
+ "content": {
8034
+ "application/json": {
8035
+ "schema": {
8036
+ "type": "object",
8037
+ "properties": {
8038
+ "data": {
8039
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
8040
+ "type": "object",
8041
+ "properties": {
8042
+ "period": {
8043
+ "type": "string",
8044
+ "enum": [
8045
+ "today",
8046
+ "7d",
8047
+ "30d",
8048
+ "90d",
8049
+ "12m",
8050
+ "custom"
8051
+ ]
8052
+ },
8053
+ "from": {
8054
+ "type": "string"
8055
+ },
8056
+ "to": {
8057
+ "type": "string"
8058
+ },
8059
+ "totals": {
8060
+ "type": "object",
8061
+ "properties": {
8062
+ "views": {
8063
+ "type": "number"
8064
+ },
8065
+ "visitors": {
8066
+ "description": "Null when no site counts visitors. Otherwise the sum over the sites that do.",
8067
+ "type": [
8068
+ "number",
8069
+ "null"
8070
+ ]
8071
+ },
8072
+ "form_sends": {
8073
+ "type": "number"
8074
+ }
8075
+ },
8076
+ "required": [
8077
+ "views",
8078
+ "visitors",
8079
+ "form_sends"
8080
+ ],
8081
+ "additionalProperties": false,
8082
+ "description": "Every live site together."
8083
+ },
8084
+ "sites": {
8085
+ "type": "array",
8086
+ "items": {
8087
+ "type": "object",
8088
+ "properties": {
8089
+ "site_id": {
8090
+ "type": "string"
8091
+ },
8092
+ "name": {
8093
+ "type": "string"
8094
+ },
8095
+ "url": {
8096
+ "type": "string"
8097
+ },
8098
+ "live": {
8099
+ "type": "boolean",
8100
+ "description": "Published: only a live site has visitors. A site never published has no figures."
8101
+ },
8102
+ "visitor_counting": {
8103
+ "type": "boolean"
8104
+ },
8105
+ "totals": {
8106
+ "anyOf": [
8107
+ {
8108
+ "type": "object",
8109
+ "properties": {
8110
+ "views": {
8111
+ "type": "number"
8112
+ },
8113
+ "visitors": {
8114
+ "type": [
8115
+ "number",
8116
+ "null"
8117
+ ]
8118
+ },
8119
+ "visits": {
8120
+ "type": [
8121
+ "number",
8122
+ "null"
8123
+ ]
8124
+ },
8125
+ "bounce_rate": {
8126
+ "description": "Share of visits with a single page view, 0 to 1.",
8127
+ "type": [
8128
+ "number",
8129
+ "null"
8130
+ ]
8131
+ },
8132
+ "visit_seconds": {
8133
+ "type": [
8134
+ "number",
8135
+ "null"
8136
+ ]
8137
+ },
8138
+ "views_per_visit": {
8139
+ "type": [
8140
+ "number",
8141
+ "null"
8142
+ ]
8143
+ },
8144
+ "form_sends": {
8145
+ "description": "Form sends the site kept, spam aside. Counted on every site: a send carries no visitor hash. Null with a filter.",
8146
+ "type": [
8147
+ "number",
8148
+ "null"
8149
+ ]
8150
+ }
8151
+ },
8152
+ "required": [
8153
+ "views",
8154
+ "visitors",
8155
+ "visits",
8156
+ "bounce_rate",
8157
+ "visit_seconds",
8158
+ "views_per_visit",
8159
+ "form_sends"
8160
+ ],
8161
+ "additionalProperties": false
8162
+ },
8163
+ {
8164
+ "type": "null"
8165
+ }
8166
+ ]
8167
+ },
8168
+ "previous": {
8169
+ "anyOf": [
8170
+ {
8171
+ "type": "object",
8172
+ "properties": {
8173
+ "views": {
8174
+ "type": "number"
8175
+ },
8176
+ "visitors": {
8177
+ "type": [
8178
+ "number",
8179
+ "null"
8180
+ ]
8181
+ },
8182
+ "visits": {
8183
+ "type": [
8184
+ "number",
8185
+ "null"
8186
+ ]
8187
+ },
8188
+ "bounce_rate": {
8189
+ "description": "Share of visits with a single page view, 0 to 1.",
8190
+ "type": [
8191
+ "number",
8192
+ "null"
8193
+ ]
8194
+ },
8195
+ "visit_seconds": {
8196
+ "type": [
8197
+ "number",
8198
+ "null"
8199
+ ]
8200
+ },
8201
+ "views_per_visit": {
8202
+ "type": [
8203
+ "number",
8204
+ "null"
8205
+ ]
8206
+ },
8207
+ "form_sends": {
8208
+ "description": "Form sends the site kept, spam aside. Counted on every site: a send carries no visitor hash. Null with a filter.",
8209
+ "type": [
8210
+ "number",
8211
+ "null"
8212
+ ]
8213
+ }
8214
+ },
8215
+ "required": [
8216
+ "views",
8217
+ "visitors",
8218
+ "visits",
8219
+ "bounce_rate",
8220
+ "visit_seconds",
8221
+ "views_per_visit",
8222
+ "form_sends"
8223
+ ],
8224
+ "additionalProperties": false
8225
+ },
8226
+ {
8227
+ "type": "null"
8228
+ }
8229
+ ],
8230
+ "description": "The same number of days just before."
8231
+ },
8232
+ "top_page": {
8233
+ "type": [
8234
+ "string",
8235
+ "null"
8236
+ ]
8237
+ },
8238
+ "top_channel": {
8239
+ "anyOf": [
8240
+ {
8241
+ "type": "string",
8242
+ "enum": [
8243
+ "search",
8244
+ "ai",
8245
+ "social",
8246
+ "email",
8247
+ "referral",
8248
+ "campaign",
8249
+ "direct"
8250
+ ]
8251
+ },
8252
+ {
8253
+ "type": "null"
8254
+ }
8255
+ ]
8256
+ },
8257
+ "top_assistant": {
8258
+ "description": "The AI assistant that sent the most people, when any did.",
8259
+ "type": [
8260
+ "string",
8261
+ "null"
8262
+ ]
8263
+ }
8264
+ },
8265
+ "required": [
8266
+ "site_id",
8267
+ "name",
8268
+ "url",
8269
+ "live",
8270
+ "visitor_counting",
8271
+ "totals",
8272
+ "previous",
8273
+ "top_page",
8274
+ "top_channel",
8275
+ "top_assistant"
8276
+ ],
8277
+ "additionalProperties": false
8278
+ },
8279
+ "description": "One row per site, live sites first, most viewed first. For the detail of one, getSiteAnalytics."
8280
+ }
8281
+ },
8282
+ "required": [
8283
+ "period",
8284
+ "from",
8285
+ "to",
8286
+ "totals",
8287
+ "sites"
8288
+ ],
8289
+ "additionalProperties": false
8290
+ },
8291
+ "request_id": {
8292
+ "type": "string"
8293
+ }
8294
+ },
8295
+ "required": [
8296
+ "data",
8297
+ "request_id"
8298
+ ]
8299
+ }
8300
+ }
8301
+ }
8302
+ },
8303
+ "400": {
8304
+ "$ref": "#/components/responses/Error400"
8305
+ },
8306
+ "401": {
8307
+ "$ref": "#/components/responses/Error401"
8308
+ },
8309
+ "402": {
8310
+ "$ref": "#/components/responses/Error402"
8311
+ },
8312
+ "403": {
8313
+ "$ref": "#/components/responses/Error403"
8314
+ },
8315
+ "404": {
8316
+ "$ref": "#/components/responses/Error404"
8317
+ },
8318
+ "409": {
8319
+ "$ref": "#/components/responses/Error409"
8320
+ },
8321
+ "410": {
8322
+ "$ref": "#/components/responses/Error410"
8323
+ },
8324
+ "413": {
8325
+ "$ref": "#/components/responses/Error413"
8326
+ },
8327
+ "422": {
8328
+ "$ref": "#/components/responses/Error422"
8329
+ },
8330
+ "429": {
8331
+ "$ref": "#/components/responses/Error429"
8332
+ },
8333
+ "500": {
8334
+ "$ref": "#/components/responses/Error500"
8335
+ },
8336
+ "503": {
8337
+ "$ref": "#/components/responses/Error503"
8338
+ }
8339
+ }
8340
+ },
7937
8341
  {
7938
8342
  "operation_id": "getSiteConsent",
7939
8343
  "method": "GET",
@@ -8077,6 +8481,18 @@ export const API_OPERATIONS = [
8077
8481
  }
8078
8482
  ]
8079
8483
  },
8484
+ "stops_on": {
8485
+ "anyOf": [
8486
+ {
8487
+ "type": "string",
8488
+ "description": "ISO 8601, UTC."
8489
+ },
8490
+ {
8491
+ "type": "null"
8492
+ }
8493
+ ],
8494
+ "description": "Stopped by the owner: it stays until this day, already paid for, then the next publication shows the standard banner."
8495
+ },
8080
8496
  "price_eur": {
8081
8497
  "type": "number"
8082
8498
  }
@@ -8085,6 +8501,7 @@ export const API_OPERATIONS = [
8085
8501
  "active",
8086
8502
  "ends_at_period_end",
8087
8503
  "current_period_end",
8504
+ "stops_on",
8088
8505
  "price_eur"
8089
8506
  ],
8090
8507
  "additionalProperties": false,
@@ -8389,6 +8806,18 @@ export const API_OPERATIONS = [
8389
8806
  }
8390
8807
  ]
8391
8808
  },
8809
+ "stops_on": {
8810
+ "anyOf": [
8811
+ {
8812
+ "type": "string",
8813
+ "description": "ISO 8601, UTC."
8814
+ },
8815
+ {
8816
+ "type": "null"
8817
+ }
8818
+ ],
8819
+ "description": "Stopped by the owner: it stays until this day, already paid for, then the next publication shows the standard banner."
8820
+ },
8392
8821
  "price_eur": {
8393
8822
  "type": "number"
8394
8823
  }
@@ -8397,6 +8826,7 @@ export const API_OPERATIONS = [
8397
8826
  "active",
8398
8827
  "ends_at_period_end",
8399
8828
  "current_period_end",
8829
+ "stops_on",
8400
8830
  "price_eur"
8401
8831
  ],
8402
8832
  "additionalProperties": false,