From 4235f58ed54db7984301131370e138287c7e2c93 Mon Sep 17 00:00:00 2001
From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com>
Date: Thu, 15 Oct 2026 18:34:34 +0000
Subject: [PATCH 1/2] [fern-generated] Update SDK
Generated by Fern
CLI Version: unknown
Generators:
- fernapi/fern-python-sdk: 4.63.4
---
.fern/metadata.json | 6 +-
.fern/replay.lock | 10 +
.fernignore | 5 +-
.gitattributes | 1 +
poetry.lock | 134 +-
pyproject.toml | 2 +-
reference.md | 11068 +++++++++++++---
src/webflow/__init__.py | 738 +-
src/webflow/client.py | 81 +-
src/webflow/core/client_wrapper.py | 4 +-
src/webflow/errors/__init__.py | 3 +
.../errors/service_unavailable_error.py | 11 +
src/webflow/resources/__init__.py | 36 +-
src/webflow/resources/analyze/__init__.py | 70 +
src/webflow/resources/analyze/client.py | 82 +
src/webflow/resources/analyze/raw_client.py | 13 +
.../resources/analyze/resources/__init__.py | 69 +
.../analyze/resources/goals/__init__.py | 34 +
.../analyze/resources/goals/client.py | 414 +
.../analyze/resources/goals/raw_client.py | 664 +
.../analyze/resources/goals/types/__init__.py | 36 +
...ls_goal_performance_request_device_type.py | 5 +
.../analyze/resources/reports/__init__.py | 61 +
.../analyze/resources/reports/client.py | 2336 ++++
.../analyze/resources/reports/raw_client.py | 3233 +++++
.../resources/reports/types/__init__.py | 59 +
...owser_window_height_request_device_type.py | 5 +
.../reports_page_flow_request_device_type.py | 5 +
...eports_scroll_depth_request_device_type.py | 5 +
...eports_time_on_page_request_device_type.py | 5 +
...orts_top_dimensions_request_device_type.py | 5 +
.../reports_top_events_request_device_type.py | 5 +
.../reports_top_pages_request_device_type.py | 5 +
.../reports_traffic_request_device_type.py | 5 +
src/webflow/resources/assets/client.py | 106 +-
src/webflow/resources/assets/raw_client.py | 90 +-
src/webflow/resources/collections/__init__.py | 33 +
src/webflow/resources/collections/client.py | 143 +
.../resources/collections/raw_client.py | 277 +
.../collections/resources/__init__.py | 33 +
.../resources/fields/raw_client.py | 6 -
.../collections/resources/items/__init__.py | 33 +
.../collections/resources/items/client.py | 964 +-
.../collections/resources/items/raw_client.py | 1110 +-
.../resources/items/types/__init__.py | 33 +
...ms_delete_items_live_request_items_item.py | 2 +-
.../items_delete_items_request_items_item.py | 2 +-
.../types/items_insert_items_response.py | 23 +
...ms_list_items_live_request_filter_value.py | 36 +
..._items_live_request_filter_value_exists.py | 5 +
...list_items_live_request_filter_value_in.py | 5 +
...ist_items_live_request_filter_value_nin.py | 5 +
.../items_list_items_live_request_sort_by.py | 4 +-
...tems_list_items_live_request_sort_value.py | 5 +
.../items_list_items_request_filter_value.py | 36 +
..._list_items_request_filter_value_exists.py | 5 +
...tems_list_items_request_filter_value_in.py | 5 +
...ems_list_items_request_filter_value_nin.py | 5 +
.../types/items_list_items_request_sort_by.py | 4 +-
.../items_list_items_request_sort_value.py | 5 +
.../resources/items/types/multiple_items.py | 2 +-
.../items/types/multiple_live_items.py | 2 +-
src/webflow/resources/components/client.py | 80 +-
.../resources/components/raw_client.py | 76 +-
.../resources/custom_fonts/__init__.py | 58 +
src/webflow/resources/custom_fonts/client.py | 1047 ++
.../resources/custom_fonts/raw_client.py | 2277 ++++
.../resources/custom_fonts/types/__init__.py | 58 +
...om_font_batch_create_request_items_item.py | 64 +
..._create_request_items_item_font_display.py | 7 +
...om_font_batch_delete_request_items_item.py | 22 +
...ustom_fonts_create_request_font_display.py | 7 +
.../types/custom_fonts_get_response.py | 24 +
...ustom_fonts_update_request_font_display.py | 7 +
.../types/custom_fonts_update_response.py | 24 +
src/webflow/resources/optimize/__init__.py | 34 +
src/webflow/resources/optimize/client.py | 145 +
src/webflow/resources/optimize/raw_client.py | 241 +
.../resources/optimize/resources/__init__.py | 34 +
.../resources/optimizations/__init__.py | 34 +
.../resources/optimizations/client.py | 794 ++
.../resources/optimizations/raw_client.py | 1355 ++
.../optimizations/resources/__init__.py | 34 +
.../resources/dimensions/__init__.py | 4 +
.../resources/dimensions/client.py | 387 +
.../resources/dimensions/raw_client.py | 671 +
.../optimizations/resources/goals/__init__.py | 4 +
.../optimizations/resources/goals/client.py | 186 +
.../resources/goals/raw_client.py | 326 +
src/webflow/resources/pages/client.py | 108 +-
src/webflow/resources/pages/raw_client.py | 86 +-
.../pages/resources/scripts/client.py | 8 +
.../pages/resources/scripts/raw_client.py | 14 +-
src/webflow/resources/scripts/client.py | 12 +
src/webflow/resources/scripts/raw_client.py | 12 +
src/webflow/resources/sites/__init__.py | 16 +-
src/webflow/resources/sites/client.py | 85 +-
src/webflow/resources/sites/raw_client.py | 28 +-
.../resources/sites/resources/__init__.py | 23 +-
.../resources/sites/resources/aeo/__init__.py | 55 +
.../resources/sites/resources/aeo/client.py | 101 +
.../sites/resources/aeo/raw_client.py | 13 +
.../sites/resources/aeo/resources/__init__.py | 50 +
.../resources/prompt_executions/__init__.py | 4 +
.../aeo/resources/prompt_executions/client.py | 350 +
.../resources/prompt_executions/raw_client.py | 603 +
.../aeo/resources/prompts/__init__.py | 34 +
.../resources/aeo/resources/prompts/client.py | 181 +
.../aeo/resources/prompts/raw_client.py | 318 +
.../aeo/resources/prompts/types/__init__.py | 34 +
.../types/prompts_list_request_status.py | 5 +
.../aeo/resources/reports/__init__.py | 37 +
.../resources/aeo/resources/reports/client.py | 1866 +++
.../aeo/resources/reports/raw_client.py | 3083 +++++
.../aeo/resources/reports/types/__init__.py | 38 +
...reports_citation_rate_request_breakdown.py | 5 +
..._visibility_breakdown_request_breakdown.py | 5 +
.../sites/resources/comments/client.py | 254 +-
.../sites/resources/comments/raw_client.py | 514 +-
.../sites/resources/google_tag/__init__.py | 4 +
.../sites/resources/google_tag/client.py | 388 +
.../sites/resources/google_tag/raw_client.py | 863 ++
.../sites/resources/members/__init__.py | 34 +
.../sites/resources/members/client.py | 758 ++
.../sites/resources/members/raw_client.py | 1728 +++
.../sites/resources/members/types/__init__.py | 36 +
...rant_site_member_request_body_site_role.py | 7 +
.../sites/resources/redirects/raw_client.py | 12 -
.../sites/resources/robots_txt/raw_client.py | 18 -
.../sites/resources/scripts/client.py | 12 +
.../sites/resources/scripts/raw_client.py | 18 +-
src/webflow/resources/sites/types/__init__.py | 8 +-
.../sites/types/sites_publish_response.py | 6 +
.../sites_publish_response_publish_scope.py | 5 +
src/webflow/resources/token/client.py | 8 +-
src/webflow/resources/token/raw_client.py | 8 +-
src/webflow/resources/webhooks/client.py | 4 +-
src/webflow/resources/webhooks/raw_client.py | 10 +-
src/webflow/resources/workspaces/__init__.py | 18 +
src/webflow/resources/workspaces/client.py | 93 +
.../resources/workspaces/raw_client.py | 193 +
.../workspaces/resources/__init__.py | 21 +-
.../workspaces/resources/members/__init__.py | 52 +
.../workspaces/resources/members/client.py | 764 ++
.../resources/members/raw_client.py | 1553 +++
.../resources/members/types/__init__.py | 54 +
...er_roles_request_body_default_site_role.py | 7 +
...orkspace_member_roles_request_body_role.py | 5 +
...members_list_members_request_roles_item.py | 7 +
...ber_role_request_body_default_site_role.py | 7 +
...workspace_member_role_request_body_role.py | 5 +
src/webflow/types/__init__.py | 728 +-
src/webflow/types/aeo_answer_engine.py | 31 +
src/webflow/types/aeo_answer_engine_key.py | 5 +
.../types/aeo_answer_engines_filter.py | 7 +
src/webflow/types/aeo_bot_category.py | 5 +
src/webflow/types/aeo_bot_provider.py | 22 +
src/webflow/types/aeo_bot_traffic_filter.py | 35 +
src/webflow/types/aeo_bot_traffic_page.py | 33 +
.../types/aeo_bot_traffic_pages_response.py | 33 +
src/webflow/types/aeo_bot_traffic_response.py | 37 +
src/webflow/types/aeo_brand_names.py | 5 +
src/webflow/types/aeo_citation_filter.py | 38 +
.../types/aeo_citation_rate_response.py | 44 +
.../aeo_citation_rate_response_breakdown.py | 5 +
.../aeo_citation_rate_response_data_item.py | 39 +
src/webflow/types/aeo_citations_response.py | 53 +
.../types/aeo_citations_response_data_item.py | 53 +
.../types/aeo_cited_domain_paths_response.py | 38 +
src/webflow/types/aeo_cited_path.py | 30 +
.../aeo_competitor_citations_response.py | 43 +
...competitor_citations_response_data_item.py | 38 +
src/webflow/types/aeo_owned_cited_path.py | 35 +
src/webflow/types/aeo_page.py | 43 +
.../types/aeo_page_citation_share_response.py | 47 +
..._page_citation_share_response_data_item.py | 33 +
...aeo_page_citation_share_response_filter.py | 30 +
.../aeo_page_citation_share_response_page.py | 41 +
src/webflow/types/aeo_prompt.py | 80 +
src/webflow/types/aeo_prompt_execution.py | 99 +
.../aeo_prompt_execution_list_response.py | 34 +
.../aeo_prompt_execution_prompt_status.py | 7 +
.../types/aeo_prompt_execution_status.py | 5 +
.../types/aeo_prompt_execution_topic.py | 31 +
src/webflow/types/aeo_prompt_ids_filter.py | 5 +
src/webflow/types/aeo_prompt_label.py | 31 +
src/webflow/types/aeo_prompt_list_response.py | 34 +
src/webflow/types/aeo_prompt_status.py | 5 +
src/webflow/types/aeo_prompt_topic.py | 31 +
src/webflow/types/aeo_timeseries.py | 37 +
.../aeo_timeseries_granularity_period.py | 5 +
.../types/aeo_top_cited_domains_response.py | 33 +
...eo_top_cited_domains_response_data_item.py | 46 +
src/webflow/types/aeo_topic_engine_filter.py | 34 +
src/webflow/types/aeo_topic_ids_filter.py | 5 +
src/webflow/types/aeo_topic_label.py | 31 +
.../aeo_visibility_breakdown_response.py | 50 +
...visibility_breakdown_response_breakdown.py | 5 +
...visibility_breakdown_response_data_item.py | 35 +
src/webflow/types/aeo_visibility_filter.py | 36 +
src/webflow/types/aeo_visibility_response.py | 45 +
.../aeo_visibility_response_data_item.py | 30 +
src/webflow/types/aeo_visibility_score.py | 3 +
src/webflow/types/aeo_window.py | 35 +
src/webflow/types/analyze_bucket_time_zone.py | 3 +
src/webflow/types/analyze_daily_bucketing.py | 33 +
.../types/analyze_daily_timeseries_query.py | 28 +
src/webflow/types/analyze_filter_operators.py | 46 +
.../types/analyze_time_on_page_bucketing.py | 32 +
src/webflow/types/analyze_window.py | 39 +
src/webflow/types/asset.py | 8 +
src/webflow/types/authorization.py | 5 +-
src/webflow/types/branch_created_webhook.py | 29 +
.../types/branch_created_webhook_payload.py | 49 +
src/webflow/types/branch_deleted_webhook.py | 29 +
.../types/branch_deleted_webhook_payload.py | 42 +
src/webflow/types/branch_merged_webhook.py | 29 +
.../types/branch_merged_webhook_payload.py | 42 +
.../types/browser_window_height_data_point.py | 32 +
.../types/browser_window_height_filter.py | 114 +
.../types/browser_window_height_response.py | 37 +
src/webflow/types/bulk_collection_item.py | 5 +-
.../types/collaborator_client_invite.py | 34 +
src/webflow/types/collection.py | 7 +
src/webflow/types/collection_item.py | 5 +-
.../types/collection_item_patch_single.py | 5 +-
.../types/collection_item_post_single.py | 5 +-
.../types/collection_item_with_id_input.py | 5 +-
src/webflow/types/comment_payload.py | 14 +-
src/webflow/types/comment_payload_type.py | 5 +
src/webflow/types/component_property.py | 44 +-
src/webflow/types/component_property_text.py | 45 +
.../types/component_property_text_type.py | 5 +
src/webflow/types/component_property_type.py | 5 -
src/webflow/types/custom_font.py | 72 +
src/webflow/types/custom_font_axis.py | 52 +
.../custom_font_batch_create_response.py | 33 +
...ont_batch_create_response_created_item.py} | 9 +-
..._font_batch_create_response_failed_item.py | 39 +
.../custom_font_batch_delete_response.py | 26 +
...font_batch_delete_response_deleted_item.py | 22 +
..._font_batch_delete_response_failed_item.py | 32 +
.../types/custom_font_create_response.py | 30 +
src/webflow/types/custom_font_font_display.py | 5 +
src/webflow/types/custom_font_format.py | 7 +
src/webflow/types/custom_font_upload.py | 40 +
.../types/custom_font_upload_fields.py | 94 +
src/webflow/types/custom_fonts.py | 30 +
src/webflow/types/error_code.py | 69 +
src/webflow/types/field_group.py | 38 +
...field_validations_additional_properties.py | 8 +-
src/webflow/types/form_submission.py | 8 +
.../types/form_submission_trigger_payload.py | 8 +
src/webflow/types/goal.py | 90 +
src/webflow/types/goal_category.py | 5 +
src/webflow/types/goal_integration_source.py | 5 +
.../types/goal_performance_data_point.py | 32 +
src/webflow/types/goal_performance_filter.py | 114 +
.../types/goal_performance_response.py | 36 +
src/webflow/types/goal_scope.py | 5 +
src/webflow/types/goal_type.py | 5 +
src/webflow/types/goal_value_type.py | 5 +
src/webflow/types/goals_response.py | 27 +
src/webflow/types/google_tag_id.py | 42 +
src/webflow/types/google_tag_ids.py | 30 +
src/webflow/types/insert_collection_item.py | 66 +
.../insert_collection_item_field_data.py | 27 +
src/webflow/types/inserted_collection_item.py | 69 +
.../inserted_collection_item_field_data.py | 27 +
.../invite_workspace_member_request_body.py | 9 +
...ody_default_site_role_default_site_role.py | 7 +
...t_body_default_site_role_workspace_role.py | 7 +
...ber_request_body_email_site_access_item.py | 37 +
...t_body_email_site_access_item_site_role.py | 7 +
...ember_request_body_one_site_access_item.py | 37 +
...est_body_one_site_access_item_site_role.py | 7 +
..._member_request_body_one_workspace_role.py | 7 +
.../invite_workspace_member_response_body.py | 53 +
...e_workspace_member_response_body_active.py | 20 +
...ace_audit_log_item_actor.py => invited.py} | 6 +-
...tems_list_items_live_request_created_on.py | 28 +
...ms_list_items_live_request_last_updated.py | 28 +
.../items_list_items_request_created_on.py | 28 +
.../items_list_items_request_last_updated.py | 28 +
src/webflow/types/optimization.py | 66 +
...optimization_audience_insights_response.py | 58 +
.../optimization_dimension_values_response.py | 54 +
.../types/optimization_dimensions_response.py | 37 +
.../types/optimization_goals_response.py | 47 +
src/webflow/types/optimization_interval.py | 40 +
.../types/optimization_list_response.py | 44 +
src/webflow/types/optimization_status.py | 5 +
.../types/optimization_summary_response.py | 50 +
.../types/optimization_trend_response.py | 60 +
src/webflow/types/optimization_type.py | 5 +
src/webflow/types/optimize_applied_filter.py | 7 +
.../types/optimize_applied_filter_entry.py | 38 +
.../types/optimize_audience_segment.py | 80 +
.../types/optimize_audience_variation.py | 37 +
src/webflow/types/optimize_current_goal.py | 49 +
src/webflow/types/optimize_dimension.py | 31 +
src/webflow/types/optimize_dimension_value.py | 39 +
src/webflow/types/optimize_filter.py | 7 +
.../types/optimize_filter_operators.py | 36 +
src/webflow/types/optimize_goal.py | 54 +
.../types/optimize_goal_counting_method.py | 5 +
.../types/optimize_goal_metric_type.py | 5 +
src/webflow/types/optimize_goal_scope.py | 5 +
src/webflow/types/optimize_goal_source.py | 5 +
.../optimize_non_webflow_site_resource.py | 38 +
src/webflow/types/optimize_reference.py | 37 +
.../types/optimize_reference_list_response.py | 27 +
.../types/optimize_reference_resource.py | 64 +
src/webflow/types/optimize_report_goal.py | 31 +
.../types/optimize_report_interval_end.py | 5 +
.../types/optimize_report_interval_start.py | 5 +
src/webflow/types/optimize_trend_direction.py | 5 +
.../types/optimize_trend_granularity.py | 5 +
src/webflow/types/optimize_trend_point.py | 33 +
.../types/optimize_variation_comparison.py | 53 +
.../types/optimize_variation_result.py | 69 +
.../types/optimize_webflow_site_resource.py | 37 +
.../types/page_created_webhook_payload.py | 20 +
.../types/page_deleted_webhook_payload.py | 20 +
src/webflow/types/page_flow_direction.py | 5 +
src/webflow/types/page_flow_filter.py | 114 +
src/webflow/types/page_flow_metric_scope.py | 5 +
src/webflow/types/page_flow_response.py | 71 +
src/webflow/types/page_flow_row.py | 60 +
.../page_metadata_updated_webhook_payload.py | 20 +
src/webflow/types/person_actor.py | 27 +
src/webflow/types/scroll_depth_data_point.py | 37 +
src/webflow/types/scroll_depth_filter.py | 114 +
src/webflow/types/scroll_depth_response.py | 37 +
src/webflow/types/setting_change.py | 3 +-
src/webflow/types/site_activity_log_item.py | 31 +
.../site_activity_log_item_actor_type.py | 5 +
.../types/site_activity_log_item_source.py | 5 +
src/webflow/types/site_member.py | 45 +
src/webflow/types/site_member_roles.py | 43 +
src/webflow/types/site_member_roles_site.py | 18 +
.../types/site_member_roles_workspace.py | 7 +
src/webflow/types/site_members_response.py | 29 +
.../types/site_members_response_pagination.py | 37 +
src/webflow/types/site_publish_payload.py | 13 +-
.../site_publish_payload_publish_scope.py | 5 +
src/webflow/types/time_on_page_data_point.py | 38 +
src/webflow/types/time_on_page_filter.py | 114 +
.../types/time_on_page_granularity_period.py | 5 +
.../types/time_on_page_metric_scope.py | 5 +
src/webflow/types/time_on_page_response.py | 45 +
.../types/time_on_page_timeseries_query.py | 32 +
src/webflow/types/token_actor.py | 27 +
src/webflow/types/top_dimensions_dimension.py | 24 +
src/webflow/types/top_dimensions_filter.py | 114 +
.../types/top_dimensions_metric_scope.py | 5 +
src/webflow/types/top_dimensions_response.py | 50 +
src/webflow/types/top_dimensions_row.py | 41 +
.../types/top_events_cms_context_entry.py | 32 +
.../top_events_component_context_entry.py | 34 +
src/webflow/types/top_events_filter.py | 85 +
src/webflow/types/top_events_response.py | 44 +
src/webflow/types/top_events_row.py | 93 +
.../types/top_events_timeseries_point.py | 34 +
src/webflow/types/top_pages_filter.py | 114 +
src/webflow/types/top_pages_response.py | 48 +
src/webflow/types/top_pages_row.py | 76 +
src/webflow/types/top_pages_sort_by.py | 5 +
.../types/top_pages_timeseries_point.py | 39 +
src/webflow/types/traffic_data_point.py | 32 +
src/webflow/types/traffic_filter.py | 114 +
src/webflow/types/traffic_metric_scope.py | 5 +
src/webflow/types/traffic_response.py | 45 +
src/webflow/types/trigger_type.py | 3 +
.../update_site_member_role_request_body.py | 34 +
...site_member_role_request_body_site_role.py | 7 +
src/webflow/types/with_default_site_role.py | 48 +
src/webflow/types/with_site_access.py | 36 +
src/webflow/types/workspace.py | 32 +
.../types/workspace_audit_log_actor.py | 52 +
src/webflow/types/workspace_audit_log_item.py | 4 +-
..._log_item_payload_setting_change_method.py | 5 -
...log_item_payload_site_membership_method.py | 2 +-
...tem_payload_workspace_invitation_method.py | 2 +-
...tem_payload_workspace_membership_method.py | 2 +-
.../workspace_bulk_role_change_response.py | 33 +
..._bulk_role_change_response_results_item.py | 40 +
...role_change_response_results_item_error.py | 34 +
...change_response_results_item_error_code.py | 16 +
...le_change_response_results_item_outcome.py | 5 +
..._role_change_response_results_item_type.py | 5 +
...space_bulk_role_change_response_summary.py | 31 +
...nvitation_audit_log_item_event_sub_type.py | 3 +-
src/webflow/types/workspace_invite.py | 75 +
.../workspace_invite_default_site_role.py | 18 +
src/webflow/types/workspace_invite_role.py | 7 +
src/webflow/types/workspace_invite_status.py | 5 +
src/webflow/types/workspace_member.py | 55 +
src/webflow/types/workspace_member_roles.py | 33 +
.../types/workspace_member_roles_site.py | 18 +
.../types/workspace_member_roles_workspace.py | 7 +
.../types/workspace_members_response.py | 35 +
.../workspace_members_response_pagination.py | 37 +
src/webflow/types/workspaces.py | 20 +
404 files changed, 51650 insertions(+), 1880 deletions(-)
create mode 100644 .fern/replay.lock
create mode 100644 .gitattributes
create mode 100644 src/webflow/errors/service_unavailable_error.py
create mode 100644 src/webflow/resources/analyze/__init__.py
create mode 100644 src/webflow/resources/analyze/client.py
create mode 100644 src/webflow/resources/analyze/raw_client.py
create mode 100644 src/webflow/resources/analyze/resources/__init__.py
create mode 100644 src/webflow/resources/analyze/resources/goals/__init__.py
create mode 100644 src/webflow/resources/analyze/resources/goals/client.py
create mode 100644 src/webflow/resources/analyze/resources/goals/raw_client.py
create mode 100644 src/webflow/resources/analyze/resources/goals/types/__init__.py
create mode 100644 src/webflow/resources/analyze/resources/goals/types/goals_goal_performance_request_device_type.py
create mode 100644 src/webflow/resources/analyze/resources/reports/__init__.py
create mode 100644 src/webflow/resources/analyze/resources/reports/client.py
create mode 100644 src/webflow/resources/analyze/resources/reports/raw_client.py
create mode 100644 src/webflow/resources/analyze/resources/reports/types/__init__.py
create mode 100644 src/webflow/resources/analyze/resources/reports/types/reports_browser_window_height_request_device_type.py
create mode 100644 src/webflow/resources/analyze/resources/reports/types/reports_page_flow_request_device_type.py
create mode 100644 src/webflow/resources/analyze/resources/reports/types/reports_scroll_depth_request_device_type.py
create mode 100644 src/webflow/resources/analyze/resources/reports/types/reports_time_on_page_request_device_type.py
create mode 100644 src/webflow/resources/analyze/resources/reports/types/reports_top_dimensions_request_device_type.py
create mode 100644 src/webflow/resources/analyze/resources/reports/types/reports_top_events_request_device_type.py
create mode 100644 src/webflow/resources/analyze/resources/reports/types/reports_top_pages_request_device_type.py
create mode 100644 src/webflow/resources/analyze/resources/reports/types/reports_traffic_request_device_type.py
create mode 100644 src/webflow/resources/collections/resources/items/types/items_insert_items_response.py
create mode 100644 src/webflow/resources/collections/resources/items/types/items_list_items_live_request_filter_value.py
create mode 100644 src/webflow/resources/collections/resources/items/types/items_list_items_live_request_filter_value_exists.py
create mode 100644 src/webflow/resources/collections/resources/items/types/items_list_items_live_request_filter_value_in.py
create mode 100644 src/webflow/resources/collections/resources/items/types/items_list_items_live_request_filter_value_nin.py
create mode 100644 src/webflow/resources/collections/resources/items/types/items_list_items_live_request_sort_value.py
create mode 100644 src/webflow/resources/collections/resources/items/types/items_list_items_request_filter_value.py
create mode 100644 src/webflow/resources/collections/resources/items/types/items_list_items_request_filter_value_exists.py
create mode 100644 src/webflow/resources/collections/resources/items/types/items_list_items_request_filter_value_in.py
create mode 100644 src/webflow/resources/collections/resources/items/types/items_list_items_request_filter_value_nin.py
create mode 100644 src/webflow/resources/collections/resources/items/types/items_list_items_request_sort_value.py
create mode 100644 src/webflow/resources/custom_fonts/__init__.py
create mode 100644 src/webflow/resources/custom_fonts/client.py
create mode 100644 src/webflow/resources/custom_fonts/raw_client.py
create mode 100644 src/webflow/resources/custom_fonts/types/__init__.py
create mode 100644 src/webflow/resources/custom_fonts/types/custom_font_batch_create_request_items_item.py
create mode 100644 src/webflow/resources/custom_fonts/types/custom_font_batch_create_request_items_item_font_display.py
create mode 100644 src/webflow/resources/custom_fonts/types/custom_font_batch_delete_request_items_item.py
create mode 100644 src/webflow/resources/custom_fonts/types/custom_fonts_create_request_font_display.py
create mode 100644 src/webflow/resources/custom_fonts/types/custom_fonts_get_response.py
create mode 100644 src/webflow/resources/custom_fonts/types/custom_fonts_update_request_font_display.py
create mode 100644 src/webflow/resources/custom_fonts/types/custom_fonts_update_response.py
create mode 100644 src/webflow/resources/optimize/__init__.py
create mode 100644 src/webflow/resources/optimize/client.py
create mode 100644 src/webflow/resources/optimize/raw_client.py
create mode 100644 src/webflow/resources/optimize/resources/__init__.py
create mode 100644 src/webflow/resources/optimize/resources/optimizations/__init__.py
create mode 100644 src/webflow/resources/optimize/resources/optimizations/client.py
create mode 100644 src/webflow/resources/optimize/resources/optimizations/raw_client.py
create mode 100644 src/webflow/resources/optimize/resources/optimizations/resources/__init__.py
create mode 100644 src/webflow/resources/optimize/resources/optimizations/resources/dimensions/__init__.py
create mode 100644 src/webflow/resources/optimize/resources/optimizations/resources/dimensions/client.py
create mode 100644 src/webflow/resources/optimize/resources/optimizations/resources/dimensions/raw_client.py
create mode 100644 src/webflow/resources/optimize/resources/optimizations/resources/goals/__init__.py
create mode 100644 src/webflow/resources/optimize/resources/optimizations/resources/goals/client.py
create mode 100644 src/webflow/resources/optimize/resources/optimizations/resources/goals/raw_client.py
create mode 100644 src/webflow/resources/sites/resources/aeo/__init__.py
create mode 100644 src/webflow/resources/sites/resources/aeo/client.py
create mode 100644 src/webflow/resources/sites/resources/aeo/raw_client.py
create mode 100644 src/webflow/resources/sites/resources/aeo/resources/__init__.py
create mode 100644 src/webflow/resources/sites/resources/aeo/resources/prompt_executions/__init__.py
create mode 100644 src/webflow/resources/sites/resources/aeo/resources/prompt_executions/client.py
create mode 100644 src/webflow/resources/sites/resources/aeo/resources/prompt_executions/raw_client.py
create mode 100644 src/webflow/resources/sites/resources/aeo/resources/prompts/__init__.py
create mode 100644 src/webflow/resources/sites/resources/aeo/resources/prompts/client.py
create mode 100644 src/webflow/resources/sites/resources/aeo/resources/prompts/raw_client.py
create mode 100644 src/webflow/resources/sites/resources/aeo/resources/prompts/types/__init__.py
create mode 100644 src/webflow/resources/sites/resources/aeo/resources/prompts/types/prompts_list_request_status.py
create mode 100644 src/webflow/resources/sites/resources/aeo/resources/reports/__init__.py
create mode 100644 src/webflow/resources/sites/resources/aeo/resources/reports/client.py
create mode 100644 src/webflow/resources/sites/resources/aeo/resources/reports/raw_client.py
create mode 100644 src/webflow/resources/sites/resources/aeo/resources/reports/types/__init__.py
create mode 100644 src/webflow/resources/sites/resources/aeo/resources/reports/types/reports_citation_rate_request_breakdown.py
create mode 100644 src/webflow/resources/sites/resources/aeo/resources/reports/types/reports_visibility_breakdown_request_breakdown.py
create mode 100644 src/webflow/resources/sites/resources/google_tag/__init__.py
create mode 100644 src/webflow/resources/sites/resources/google_tag/client.py
create mode 100644 src/webflow/resources/sites/resources/google_tag/raw_client.py
create mode 100644 src/webflow/resources/sites/resources/members/__init__.py
create mode 100644 src/webflow/resources/sites/resources/members/client.py
create mode 100644 src/webflow/resources/sites/resources/members/raw_client.py
create mode 100644 src/webflow/resources/sites/resources/members/types/__init__.py
create mode 100644 src/webflow/resources/sites/resources/members/types/grant_site_member_request_body_site_role.py
create mode 100644 src/webflow/resources/sites/types/sites_publish_response_publish_scope.py
create mode 100644 src/webflow/resources/workspaces/resources/members/__init__.py
create mode 100644 src/webflow/resources/workspaces/resources/members/client.py
create mode 100644 src/webflow/resources/workspaces/resources/members/raw_client.py
create mode 100644 src/webflow/resources/workspaces/resources/members/types/__init__.py
create mode 100644 src/webflow/resources/workspaces/resources/members/types/bulk_update_workspace_member_roles_request_body_default_site_role.py
create mode 100644 src/webflow/resources/workspaces/resources/members/types/bulk_update_workspace_member_roles_request_body_role.py
create mode 100644 src/webflow/resources/workspaces/resources/members/types/members_list_members_request_roles_item.py
create mode 100644 src/webflow/resources/workspaces/resources/members/types/update_workspace_member_role_request_body_default_site_role.py
create mode 100644 src/webflow/resources/workspaces/resources/members/types/update_workspace_member_role_request_body_role.py
create mode 100644 src/webflow/types/aeo_answer_engine.py
create mode 100644 src/webflow/types/aeo_answer_engine_key.py
create mode 100644 src/webflow/types/aeo_answer_engines_filter.py
create mode 100644 src/webflow/types/aeo_bot_category.py
create mode 100644 src/webflow/types/aeo_bot_provider.py
create mode 100644 src/webflow/types/aeo_bot_traffic_filter.py
create mode 100644 src/webflow/types/aeo_bot_traffic_page.py
create mode 100644 src/webflow/types/aeo_bot_traffic_pages_response.py
create mode 100644 src/webflow/types/aeo_bot_traffic_response.py
create mode 100644 src/webflow/types/aeo_brand_names.py
create mode 100644 src/webflow/types/aeo_citation_filter.py
create mode 100644 src/webflow/types/aeo_citation_rate_response.py
create mode 100644 src/webflow/types/aeo_citation_rate_response_breakdown.py
create mode 100644 src/webflow/types/aeo_citation_rate_response_data_item.py
create mode 100644 src/webflow/types/aeo_citations_response.py
create mode 100644 src/webflow/types/aeo_citations_response_data_item.py
create mode 100644 src/webflow/types/aeo_cited_domain_paths_response.py
create mode 100644 src/webflow/types/aeo_cited_path.py
create mode 100644 src/webflow/types/aeo_competitor_citations_response.py
create mode 100644 src/webflow/types/aeo_competitor_citations_response_data_item.py
create mode 100644 src/webflow/types/aeo_owned_cited_path.py
create mode 100644 src/webflow/types/aeo_page.py
create mode 100644 src/webflow/types/aeo_page_citation_share_response.py
create mode 100644 src/webflow/types/aeo_page_citation_share_response_data_item.py
create mode 100644 src/webflow/types/aeo_page_citation_share_response_filter.py
create mode 100644 src/webflow/types/aeo_page_citation_share_response_page.py
create mode 100644 src/webflow/types/aeo_prompt.py
create mode 100644 src/webflow/types/aeo_prompt_execution.py
create mode 100644 src/webflow/types/aeo_prompt_execution_list_response.py
create mode 100644 src/webflow/types/aeo_prompt_execution_prompt_status.py
create mode 100644 src/webflow/types/aeo_prompt_execution_status.py
create mode 100644 src/webflow/types/aeo_prompt_execution_topic.py
create mode 100644 src/webflow/types/aeo_prompt_ids_filter.py
create mode 100644 src/webflow/types/aeo_prompt_label.py
create mode 100644 src/webflow/types/aeo_prompt_list_response.py
create mode 100644 src/webflow/types/aeo_prompt_status.py
create mode 100644 src/webflow/types/aeo_prompt_topic.py
create mode 100644 src/webflow/types/aeo_timeseries.py
create mode 100644 src/webflow/types/aeo_timeseries_granularity_period.py
create mode 100644 src/webflow/types/aeo_top_cited_domains_response.py
create mode 100644 src/webflow/types/aeo_top_cited_domains_response_data_item.py
create mode 100644 src/webflow/types/aeo_topic_engine_filter.py
create mode 100644 src/webflow/types/aeo_topic_ids_filter.py
create mode 100644 src/webflow/types/aeo_topic_label.py
create mode 100644 src/webflow/types/aeo_visibility_breakdown_response.py
create mode 100644 src/webflow/types/aeo_visibility_breakdown_response_breakdown.py
create mode 100644 src/webflow/types/aeo_visibility_breakdown_response_data_item.py
create mode 100644 src/webflow/types/aeo_visibility_filter.py
create mode 100644 src/webflow/types/aeo_visibility_response.py
create mode 100644 src/webflow/types/aeo_visibility_response_data_item.py
create mode 100644 src/webflow/types/aeo_visibility_score.py
create mode 100644 src/webflow/types/aeo_window.py
create mode 100644 src/webflow/types/analyze_bucket_time_zone.py
create mode 100644 src/webflow/types/analyze_daily_bucketing.py
create mode 100644 src/webflow/types/analyze_daily_timeseries_query.py
create mode 100644 src/webflow/types/analyze_filter_operators.py
create mode 100644 src/webflow/types/analyze_time_on_page_bucketing.py
create mode 100644 src/webflow/types/analyze_window.py
create mode 100644 src/webflow/types/branch_created_webhook.py
create mode 100644 src/webflow/types/branch_created_webhook_payload.py
create mode 100644 src/webflow/types/branch_deleted_webhook.py
create mode 100644 src/webflow/types/branch_deleted_webhook_payload.py
create mode 100644 src/webflow/types/branch_merged_webhook.py
create mode 100644 src/webflow/types/branch_merged_webhook_payload.py
create mode 100644 src/webflow/types/browser_window_height_data_point.py
create mode 100644 src/webflow/types/browser_window_height_filter.py
create mode 100644 src/webflow/types/browser_window_height_response.py
create mode 100644 src/webflow/types/collaborator_client_invite.py
create mode 100644 src/webflow/types/comment_payload_type.py
create mode 100644 src/webflow/types/component_property_text.py
create mode 100644 src/webflow/types/component_property_text_type.py
delete mode 100644 src/webflow/types/component_property_type.py
create mode 100644 src/webflow/types/custom_font.py
create mode 100644 src/webflow/types/custom_font_axis.py
create mode 100644 src/webflow/types/custom_font_batch_create_response.py
rename src/webflow/types/{field_validations_additional_properties_additional_properties.py => custom_font_batch_create_response_created_item.py} (63%)
create mode 100644 src/webflow/types/custom_font_batch_create_response_failed_item.py
create mode 100644 src/webflow/types/custom_font_batch_delete_response.py
create mode 100644 src/webflow/types/custom_font_batch_delete_response_deleted_item.py
create mode 100644 src/webflow/types/custom_font_batch_delete_response_failed_item.py
create mode 100644 src/webflow/types/custom_font_create_response.py
create mode 100644 src/webflow/types/custom_font_font_display.py
create mode 100644 src/webflow/types/custom_font_format.py
create mode 100644 src/webflow/types/custom_font_upload.py
create mode 100644 src/webflow/types/custom_font_upload_fields.py
create mode 100644 src/webflow/types/custom_fonts.py
create mode 100644 src/webflow/types/field_group.py
create mode 100644 src/webflow/types/goal.py
create mode 100644 src/webflow/types/goal_category.py
create mode 100644 src/webflow/types/goal_integration_source.py
create mode 100644 src/webflow/types/goal_performance_data_point.py
create mode 100644 src/webflow/types/goal_performance_filter.py
create mode 100644 src/webflow/types/goal_performance_response.py
create mode 100644 src/webflow/types/goal_scope.py
create mode 100644 src/webflow/types/goal_type.py
create mode 100644 src/webflow/types/goal_value_type.py
create mode 100644 src/webflow/types/goals_response.py
create mode 100644 src/webflow/types/google_tag_id.py
create mode 100644 src/webflow/types/google_tag_ids.py
create mode 100644 src/webflow/types/insert_collection_item.py
create mode 100644 src/webflow/types/insert_collection_item_field_data.py
create mode 100644 src/webflow/types/inserted_collection_item.py
create mode 100644 src/webflow/types/inserted_collection_item_field_data.py
create mode 100644 src/webflow/types/invite_workspace_member_request_body.py
create mode 100644 src/webflow/types/invite_workspace_member_request_body_default_site_role_default_site_role.py
create mode 100644 src/webflow/types/invite_workspace_member_request_body_default_site_role_workspace_role.py
create mode 100644 src/webflow/types/invite_workspace_member_request_body_email_site_access_item.py
create mode 100644 src/webflow/types/invite_workspace_member_request_body_email_site_access_item_site_role.py
create mode 100644 src/webflow/types/invite_workspace_member_request_body_one_site_access_item.py
create mode 100644 src/webflow/types/invite_workspace_member_request_body_one_site_access_item_site_role.py
create mode 100644 src/webflow/types/invite_workspace_member_request_body_one_workspace_role.py
create mode 100644 src/webflow/types/invite_workspace_member_response_body.py
create mode 100644 src/webflow/types/invite_workspace_member_response_body_active.py
rename src/webflow/types/{workspace_audit_log_item_actor.py => invited.py} (78%)
create mode 100644 src/webflow/types/items_list_items_live_request_created_on.py
create mode 100644 src/webflow/types/items_list_items_live_request_last_updated.py
create mode 100644 src/webflow/types/items_list_items_request_created_on.py
create mode 100644 src/webflow/types/items_list_items_request_last_updated.py
create mode 100644 src/webflow/types/optimization.py
create mode 100644 src/webflow/types/optimization_audience_insights_response.py
create mode 100644 src/webflow/types/optimization_dimension_values_response.py
create mode 100644 src/webflow/types/optimization_dimensions_response.py
create mode 100644 src/webflow/types/optimization_goals_response.py
create mode 100644 src/webflow/types/optimization_interval.py
create mode 100644 src/webflow/types/optimization_list_response.py
create mode 100644 src/webflow/types/optimization_status.py
create mode 100644 src/webflow/types/optimization_summary_response.py
create mode 100644 src/webflow/types/optimization_trend_response.py
create mode 100644 src/webflow/types/optimization_type.py
create mode 100644 src/webflow/types/optimize_applied_filter.py
create mode 100644 src/webflow/types/optimize_applied_filter_entry.py
create mode 100644 src/webflow/types/optimize_audience_segment.py
create mode 100644 src/webflow/types/optimize_audience_variation.py
create mode 100644 src/webflow/types/optimize_current_goal.py
create mode 100644 src/webflow/types/optimize_dimension.py
create mode 100644 src/webflow/types/optimize_dimension_value.py
create mode 100644 src/webflow/types/optimize_filter.py
create mode 100644 src/webflow/types/optimize_filter_operators.py
create mode 100644 src/webflow/types/optimize_goal.py
create mode 100644 src/webflow/types/optimize_goal_counting_method.py
create mode 100644 src/webflow/types/optimize_goal_metric_type.py
create mode 100644 src/webflow/types/optimize_goal_scope.py
create mode 100644 src/webflow/types/optimize_goal_source.py
create mode 100644 src/webflow/types/optimize_non_webflow_site_resource.py
create mode 100644 src/webflow/types/optimize_reference.py
create mode 100644 src/webflow/types/optimize_reference_list_response.py
create mode 100644 src/webflow/types/optimize_reference_resource.py
create mode 100644 src/webflow/types/optimize_report_goal.py
create mode 100644 src/webflow/types/optimize_report_interval_end.py
create mode 100644 src/webflow/types/optimize_report_interval_start.py
create mode 100644 src/webflow/types/optimize_trend_direction.py
create mode 100644 src/webflow/types/optimize_trend_granularity.py
create mode 100644 src/webflow/types/optimize_trend_point.py
create mode 100644 src/webflow/types/optimize_variation_comparison.py
create mode 100644 src/webflow/types/optimize_variation_result.py
create mode 100644 src/webflow/types/optimize_webflow_site_resource.py
create mode 100644 src/webflow/types/page_flow_direction.py
create mode 100644 src/webflow/types/page_flow_filter.py
create mode 100644 src/webflow/types/page_flow_metric_scope.py
create mode 100644 src/webflow/types/page_flow_response.py
create mode 100644 src/webflow/types/page_flow_row.py
create mode 100644 src/webflow/types/person_actor.py
create mode 100644 src/webflow/types/scroll_depth_data_point.py
create mode 100644 src/webflow/types/scroll_depth_filter.py
create mode 100644 src/webflow/types/scroll_depth_response.py
create mode 100644 src/webflow/types/site_activity_log_item_actor_type.py
create mode 100644 src/webflow/types/site_activity_log_item_source.py
create mode 100644 src/webflow/types/site_member.py
create mode 100644 src/webflow/types/site_member_roles.py
create mode 100644 src/webflow/types/site_member_roles_site.py
create mode 100644 src/webflow/types/site_member_roles_workspace.py
create mode 100644 src/webflow/types/site_members_response.py
create mode 100644 src/webflow/types/site_members_response_pagination.py
create mode 100644 src/webflow/types/site_publish_payload_publish_scope.py
create mode 100644 src/webflow/types/time_on_page_data_point.py
create mode 100644 src/webflow/types/time_on_page_filter.py
create mode 100644 src/webflow/types/time_on_page_granularity_period.py
create mode 100644 src/webflow/types/time_on_page_metric_scope.py
create mode 100644 src/webflow/types/time_on_page_response.py
create mode 100644 src/webflow/types/time_on_page_timeseries_query.py
create mode 100644 src/webflow/types/token_actor.py
create mode 100644 src/webflow/types/top_dimensions_dimension.py
create mode 100644 src/webflow/types/top_dimensions_filter.py
create mode 100644 src/webflow/types/top_dimensions_metric_scope.py
create mode 100644 src/webflow/types/top_dimensions_response.py
create mode 100644 src/webflow/types/top_dimensions_row.py
create mode 100644 src/webflow/types/top_events_cms_context_entry.py
create mode 100644 src/webflow/types/top_events_component_context_entry.py
create mode 100644 src/webflow/types/top_events_filter.py
create mode 100644 src/webflow/types/top_events_response.py
create mode 100644 src/webflow/types/top_events_row.py
create mode 100644 src/webflow/types/top_events_timeseries_point.py
create mode 100644 src/webflow/types/top_pages_filter.py
create mode 100644 src/webflow/types/top_pages_response.py
create mode 100644 src/webflow/types/top_pages_row.py
create mode 100644 src/webflow/types/top_pages_sort_by.py
create mode 100644 src/webflow/types/top_pages_timeseries_point.py
create mode 100644 src/webflow/types/traffic_data_point.py
create mode 100644 src/webflow/types/traffic_filter.py
create mode 100644 src/webflow/types/traffic_metric_scope.py
create mode 100644 src/webflow/types/traffic_response.py
create mode 100644 src/webflow/types/update_site_member_role_request_body.py
create mode 100644 src/webflow/types/update_site_member_role_request_body_site_role.py
create mode 100644 src/webflow/types/with_default_site_role.py
create mode 100644 src/webflow/types/with_site_access.py
create mode 100644 src/webflow/types/workspace.py
create mode 100644 src/webflow/types/workspace_audit_log_actor.py
delete mode 100644 src/webflow/types/workspace_audit_log_item_payload_setting_change_method.py
create mode 100644 src/webflow/types/workspace_bulk_role_change_response.py
create mode 100644 src/webflow/types/workspace_bulk_role_change_response_results_item.py
create mode 100644 src/webflow/types/workspace_bulk_role_change_response_results_item_error.py
create mode 100644 src/webflow/types/workspace_bulk_role_change_response_results_item_error_code.py
create mode 100644 src/webflow/types/workspace_bulk_role_change_response_results_item_outcome.py
create mode 100644 src/webflow/types/workspace_bulk_role_change_response_results_item_type.py
create mode 100644 src/webflow/types/workspace_bulk_role_change_response_summary.py
create mode 100644 src/webflow/types/workspace_invite.py
create mode 100644 src/webflow/types/workspace_invite_default_site_role.py
create mode 100644 src/webflow/types/workspace_invite_role.py
create mode 100644 src/webflow/types/workspace_invite_status.py
create mode 100644 src/webflow/types/workspace_member.py
create mode 100644 src/webflow/types/workspace_member_roles.py
create mode 100644 src/webflow/types/workspace_member_roles_site.py
create mode 100644 src/webflow/types/workspace_member_roles_workspace.py
create mode 100644 src/webflow/types/workspace_members_response.py
create mode 100644 src/webflow/types/workspace_members_response_pagination.py
create mode 100644 src/webflow/types/workspaces.py
diff --git a/.fern/metadata.json b/.fern/metadata.json
index 44a28821..b6aea628 100644
--- a/.fern/metadata.json
+++ b/.fern/metadata.json
@@ -1,5 +1,5 @@
{
- "cliVersion": "4.22.0",
+ "cliVersion": "5.35.2",
"generatorName": "fernapi/fern-python-sdk",
"generatorVersion": "4.63.4",
"generatorConfig": {
@@ -9,6 +9,6 @@
"use_str_enums": false
}
},
- "originGitCommit": "3ad89f5558f1774e8535f034a87bfe8c2fdfcd50",
- "sdkVersion": "2.0.0"
+ "originGitCommit": "005f29a7da515da7f49554b529cc7ace5b98128c",
+ "sdkVersion": "2.0.1"
}
\ No newline at end of file
diff --git a/.fern/replay.lock b/.fern/replay.lock
new file mode 100644
index 00000000..ef809498
--- /dev/null
+++ b/.fern/replay.lock
@@ -0,0 +1,10 @@
+# DO NOT EDIT MANUALLY - Managed by Fern Replay
+version: "1.0"
+generations:
+ - commit_sha: 1e6e7e02a6c6be33f48b6569f6ca20dc332a6c1c
+ tree_hash: 5fb8f4ca091f71069b3a2604ea9f5211f2e417e5
+ timestamp: 2026-10-15T18:34:30.958Z
+ cli_version: unknown
+ generator_versions: {}
+current_generation: 1e6e7e02a6c6be33f48b6569f6ca20dc332a6c1c
+patches: []
diff --git a/.fernignore b/.fernignore
index e83159bd..e2a45657 100644
--- a/.fernignore
+++ b/.fernignore
@@ -4,4 +4,7 @@ README.md
assets/
src/webflow/oauth.py
-src/webflow/types/oauth_scope.py
\ No newline at end of file
+src/webflow/types/oauth_scope.py
+.fern/replay.lock
+.fern/replay.yml
+.gitattributes
diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 00000000..74928d6a
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1 @@
+.fern/replay.lock linguist-generated=true
diff --git a/poetry.lock b/poetry.lock
index 83fdc8b0..6a54488c 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -38,13 +38,13 @@ trio = ["trio (>=0.26.1)"]
[[package]]
name = "certifi"
-version = "2026.2.25"
+version = "2026.7.22"
description = "Python package for providing Mozilla's CA Bundle."
optional = false
python-versions = ">=3.7"
files = [
- {file = "certifi-2026.2.25-py3-none-any.whl", hash = "sha256:027692e4402ad994f1c42e52a4997a9763c646b73e4096e4d5d6db8af1d6f0fa"},
- {file = "certifi-2026.2.25.tar.gz", hash = "sha256:e887ab5cee78ea814d3472169153c2d12cd43b14bd03329a39a9c6e2e80bfba7"},
+ {file = "certifi-2026.7.22-py3-none-any.whl", hash = "sha256:62f22742b58a1a33014a2b6b706588a8d7e2a88ae7bd1a6ebe8c992928483775"},
+ {file = "certifi-2026.7.22.tar.gz", hash = "sha256:741e2c3b351ddf169a738da9f2c048608ff7f2c5cc02f1ebc6b118bb090d5d55"},
]
[[package]]
@@ -147,17 +147,17 @@ zstd = ["zstandard (>=0.18.0)"]
[[package]]
name = "idna"
-version = "3.11"
+version = "3.15"
description = "Internationalized Domain Names in Applications (IDNA)"
optional = false
python-versions = ">=3.8"
files = [
- {file = "idna-3.11-py3-none-any.whl", hash = "sha256:771a87f49d9defaf64091e6e6fe9c18d4833f140bd19464795bc32d966ca37ea"},
- {file = "idna-3.11.tar.gz", hash = "sha256:795dafcc9c04ed0c1fb032c2aa73654d8e8c5023a7df64a53f39190ada629902"},
+ {file = "idna-3.15-py3-none-any.whl", hash = "sha256:048adeaf8c2d788c40fee287673ccaa74c24ffd8dcf09ffa555a2fbb59f10ac8"},
+ {file = "idna-3.15.tar.gz", hash = "sha256:ca962446ea538f7092a95e057da437618e886f4d349216d2b1e294abfdb65fdc"},
]
[package.extras]
-all = ["flake8 (>=7.1.1)", "mypy (>=1.11.2)", "pytest (>=8.3.2)", "ruff (>=0.6.2)"]
+all = ["mypy (>=1.11.2)", "pytest (>=8.3.2)", "ruff (>=0.6.2)"]
[[package]]
name = "iniconfig"
@@ -236,13 +236,13 @@ files = [
[[package]]
name = "packaging"
-version = "26.0"
+version = "26.2"
description = "Core utilities for Python packages"
optional = false
python-versions = ">=3.8"
files = [
- {file = "packaging-26.0-py3-none-any.whl", hash = "sha256:b36f1fef9334a5588b4166f8bcd26a14e521f2b55e6b9de3aaa80d3ff7a37529"},
- {file = "packaging-26.0.tar.gz", hash = "sha256:00243ae351a257117b6a241061796684b084ed1c516a08c48a3f7e147a9d80b4"},
+ {file = "packaging-26.2-py3-none-any.whl", hash = "sha256:5fc45236b9446107ff2415ce77c807cee2862cb6fac22b8a73826d0693b0980e"},
+ {file = "packaging-26.2.tar.gz", hash = "sha256:ff452ff5a3e828ce110190feff1178bb1f2ea2281fa2075aadb987c2fb221661"},
]
[[package]]
@@ -517,58 +517,76 @@ files = [
[[package]]
name = "tomli"
-version = "2.4.0"
+version = "2.5.0"
description = "A lil' TOML parser"
optional = false
python-versions = ">=3.8"
files = [
- {file = "tomli-2.4.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:b5ef256a3fd497d4973c11bf142e9ed78b150d36f5773f1ca6088c230ffc5867"},
- {file = "tomli-2.4.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:5572e41282d5268eb09a697c89a7bee84fae66511f87533a6f88bd2f7b652da9"},
- {file = "tomli-2.4.0-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:551e321c6ba03b55676970b47cb1b73f14a0a4dce6a3e1a9458fd6d921d72e95"},
- {file = "tomli-2.4.0-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:5e3f639a7a8f10069d0e15408c0b96a2a828cfdec6fca05296ebcdcc28ca7c76"},
- {file = "tomli-2.4.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:1b168f2731796b045128c45982d3a4874057626da0e2ef1fdd722848b741361d"},
- {file = "tomli-2.4.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:133e93646ec4300d651839d382d63edff11d8978be23da4cc106f5a18b7d0576"},
- {file = "tomli-2.4.0-cp311-cp311-win32.whl", hash = "sha256:b6c78bdf37764092d369722d9946cb65b8767bfa4110f902a1b2542d8d173c8a"},
- {file = "tomli-2.4.0-cp311-cp311-win_amd64.whl", hash = "sha256:d3d1654e11d724760cdb37a3d7691f0be9db5fbdaef59c9f532aabf87006dbaa"},
- {file = "tomli-2.4.0-cp311-cp311-win_arm64.whl", hash = "sha256:cae9c19ed12d4e8f3ebf46d1a75090e4c0dc16271c5bce1c833ac168f08fb614"},
- {file = "tomli-2.4.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:920b1de295e72887bafa3ad9f7a792f811847d57ea6b1215154030cf131f16b1"},
- {file = "tomli-2.4.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:7d6d9a4aee98fac3eab4952ad1d73aee87359452d1c086b5ceb43ed02ddb16b8"},
- {file = "tomli-2.4.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:36b9d05b51e65b254ea6c2585b59d2c4cb91c8a3d91d0ed0f17591a29aaea54a"},
- {file = "tomli-2.4.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:1c8a885b370751837c029ef9bc014f27d80840e48bac415f3412e6593bbc18c1"},
- {file = "tomli-2.4.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:8768715ffc41f0008abe25d808c20c3d990f42b6e2e58305d5da280ae7d1fa3b"},
- {file = "tomli-2.4.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:7b438885858efd5be02a9a133caf5812b8776ee0c969fea02c45e8e3f296ba51"},
- {file = "tomli-2.4.0-cp312-cp312-win32.whl", hash = "sha256:0408e3de5ec77cc7f81960c362543cbbd91ef883e3138e81b729fc3eea5b9729"},
- {file = "tomli-2.4.0-cp312-cp312-win_amd64.whl", hash = "sha256:685306e2cc7da35be4ee914fd34ab801a6acacb061b6a7abca922aaf9ad368da"},
- {file = "tomli-2.4.0-cp312-cp312-win_arm64.whl", hash = "sha256:5aa48d7c2356055feef06a43611fc401a07337d5b006be13a30f6c58f869e3c3"},
- {file = "tomli-2.4.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:84d081fbc252d1b6a982e1870660e7330fb8f90f676f6e78b052ad4e64714bf0"},
- {file = "tomli-2.4.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:9a08144fa4cba33db5255f9b74f0b89888622109bd2776148f2597447f92a94e"},
- {file = "tomli-2.4.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:c73add4bb52a206fd0c0723432db123c0c75c280cbd67174dd9d2db228ebb1b4"},
- {file = "tomli-2.4.0-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:1fb2945cbe303b1419e2706e711b7113da57b7db31ee378d08712d678a34e51e"},
- {file = "tomli-2.4.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:bbb1b10aa643d973366dc2cb1ad94f99c1726a02343d43cbc011edbfac579e7c"},
- {file = "tomli-2.4.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:4cbcb367d44a1f0c2be408758b43e1ffb5308abe0ea222897d6bfc8e8281ef2f"},
- {file = "tomli-2.4.0-cp313-cp313-win32.whl", hash = "sha256:7d49c66a7d5e56ac959cb6fc583aff0651094ec071ba9ad43df785abc2320d86"},
- {file = "tomli-2.4.0-cp313-cp313-win_amd64.whl", hash = "sha256:3cf226acb51d8f1c394c1b310e0e0e61fecdd7adcb78d01e294ac297dd2e7f87"},
- {file = "tomli-2.4.0-cp313-cp313-win_arm64.whl", hash = "sha256:d20b797a5c1ad80c516e41bc1fb0443ddb5006e9aaa7bda2d71978346aeb9132"},
- {file = "tomli-2.4.0-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:26ab906a1eb794cd4e103691daa23d95c6919cc2fa9160000ac02370cc9dd3f6"},
- {file = "tomli-2.4.0-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:20cedb4ee43278bc4f2fee6cb50daec836959aadaf948db5172e776dd3d993fc"},
- {file = "tomli-2.4.0-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:39b0b5d1b6dd03684b3fb276407ebed7090bbec989fa55838c98560c01113b66"},
- {file = "tomli-2.4.0-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:a26d7ff68dfdb9f87a016ecfd1e1c2bacbe3108f4e0f8bcd2228ef9a766c787d"},
- {file = "tomli-2.4.0-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:20ffd184fb1df76a66e34bd1b36b4a4641bd2b82954befa32fe8163e79f1a702"},
- {file = "tomli-2.4.0-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:75c2f8bbddf170e8effc98f5e9084a8751f8174ea6ccf4fca5398436e0320bc8"},
- {file = "tomli-2.4.0-cp314-cp314-win32.whl", hash = "sha256:31d556d079d72db7c584c0627ff3a24c5d3fb4f730221d3444f3efb1b2514776"},
- {file = "tomli-2.4.0-cp314-cp314-win_amd64.whl", hash = "sha256:43e685b9b2341681907759cf3a04e14d7104b3580f808cfde1dfdb60ada85475"},
- {file = "tomli-2.4.0-cp314-cp314-win_arm64.whl", hash = "sha256:3d895d56bd3f82ddd6faaff993c275efc2ff38e52322ea264122d72729dca2b2"},
- {file = "tomli-2.4.0-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:5b5807f3999fb66776dbce568cc9a828544244a8eb84b84b9bafc080c99597b9"},
- {file = "tomli-2.4.0-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:c084ad935abe686bd9c898e62a02a19abfc9760b5a79bc29644463eaf2840cb0"},
- {file = "tomli-2.4.0-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:0f2e3955efea4d1cfbcb87bc321e00dc08d2bcb737fd1d5e398af111d86db5df"},
- {file = "tomli-2.4.0-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:0e0fe8a0b8312acf3a88077a0802565cb09ee34107813bba1c7cd591fa6cfc8d"},
- {file = "tomli-2.4.0-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:413540dce94673591859c4c6f794dfeaa845e98bf35d72ed59636f869ef9f86f"},
- {file = "tomli-2.4.0-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:0dc56fef0e2c1c470aeac5b6ca8cc7b640bb93e92d9803ddaf9ea03e198f5b0b"},
- {file = "tomli-2.4.0-cp314-cp314t-win32.whl", hash = "sha256:d878f2a6707cc9d53a1be1414bbb419e629c3d6e67f69230217bb663e76b5087"},
- {file = "tomli-2.4.0-cp314-cp314t-win_amd64.whl", hash = "sha256:2add28aacc7425117ff6364fe9e06a183bb0251b03f986df0e78e974047571fd"},
- {file = "tomli-2.4.0-cp314-cp314t-win_arm64.whl", hash = "sha256:2b1e3b80e1d5e52e40e9b924ec43d81570f0e7d09d11081b797bc4692765a3d4"},
- {file = "tomli-2.4.0-py3-none-any.whl", hash = "sha256:1f776e7d669ebceb01dee46484485f43a4048746235e683bcdffacdf1fb4785a"},
- {file = "tomli-2.4.0.tar.gz", hash = "sha256:aa89c3f6c277dd275d8e243ad24f3b5e701491a860d5121f2cdd399fbb31fc9c"},
+ {file = "tomli-2.5.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:c4dc1c1781f2f716de763d1e9a7b34c6a894e167e291c7c5d16c72f7a9538545"},
+ {file = "tomli-2.5.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:eff8babca5a7999bc137acbc7482a8b7e17ffca5075ab41f5d770ab408c7bfef"},
+ {file = "tomli-2.5.0-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:86665cee9c4835b7a7f1e8ec2c719b5258d4dc782887aded5a8ae7352a96843b"},
+ {file = "tomli-2.5.0-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:d7e369fd63331746182360977b1892bfc215476a30d61612d732425311639f56"},
+ {file = "tomli-2.5.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:7ad1ea345759240d6463efa0ed1c704402752e49aa21476620738d74d72d8aa1"},
+ {file = "tomli-2.5.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:96243987194634bd411066ce40c952e108f86af04db533ecd8ac3ff2a85b1885"},
+ {file = "tomli-2.5.0-cp311-cp311-win32.whl", hash = "sha256:610b27d99f28ec5f191c7064a48f3ddb179a1fe6ca73d571483ae859f57b605e"},
+ {file = "tomli-2.5.0-cp311-cp311-win_amd64.whl", hash = "sha256:c804ae44fe7b4bab5da295e4f980a1ff04670bca9d23fe0a4e887e08ebd741a8"},
+ {file = "tomli-2.5.0-cp311-cp311-win_arm64.whl", hash = "sha256:cfac177ebd6236003846ea339981f71457cb6eb748f23381eb257e45092e3980"},
+ {file = "tomli-2.5.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:1f4a40d03fb9f63424f0979855bdeaf44dd7696b8d59501822c10ed30ba532df"},
+ {file = "tomli-2.5.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:9ebf8d19b17bd0daeb7b7dec81a946a439b753942fd0210d6e96c532249eea6b"},
+ {file = "tomli-2.5.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:bf0b5e8e0f68ebb494356e577c06c139161efd8d3b9050f93b39b7c26cc54ff0"},
+ {file = "tomli-2.5.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:6cf74416bdc94ae458b14e37286c1073081850ac8459a00d0c5efef5d44294c6"},
+ {file = "tomli-2.5.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:61ea1ebe1e55a34ea8199cc8dbff398d35027b82271c8ac4802fd3a1fd5b1bcc"},
+ {file = "tomli-2.5.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:ed53f7e89bb04f6d9e8e7799112360b0c4d5cbff067de0814c98c37c39b920f7"},
+ {file = "tomli-2.5.0-cp312-cp312-win32.whl", hash = "sha256:e7ad033e27a516a233bea839cdb77b80146facb3b4f40bf02cd0cac165cdd5c2"},
+ {file = "tomli-2.5.0-cp312-cp312-win_amd64.whl", hash = "sha256:bd05de8c1698f8413dd7d869492693a0bf2211543b787ac78cd5e7536af1a6d7"},
+ {file = "tomli-2.5.0-cp312-cp312-win_arm64.whl", hash = "sha256:069435bd5480429b98c5e5afb02ab21c219b6f0064680671c6dc0d46817346ea"},
+ {file = "tomli-2.5.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:943276cf269e0071948d9ff697159c1735e623c1151d88abb09b74659ef0cbea"},
+ {file = "tomli-2.5.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:463b16086865b97facd8d0b3fb4cb7c544e3f58d2a69dc3113d6db9653fdb043"},
+ {file = "tomli-2.5.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:1245a6638fc4bb0a60af38a7d45413db34a13842027c77597c712c998c62fdf0"},
+ {file = "tomli-2.5.0-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:5d8bac3d603c97e6854424e5b2b5b741bdbde387e09f162fb0446812b4a8362b"},
+ {file = "tomli-2.5.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:21e4cae4114aba25aa0d4f85cdf486d290fb35c0954d7bba536248da64d43066"},
+ {file = "tomli-2.5.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:bbaefc84548d754be821bba7c4141c4787dda182f9e77f2f87b71213529efa7b"},
+ {file = "tomli-2.5.0-cp313-cp313-win32.whl", hash = "sha256:abdbf6313b8d9efe157edeb7ab6eae4de064b1300ad31abf73755154b30abe68"},
+ {file = "tomli-2.5.0-cp313-cp313-win_amd64.whl", hash = "sha256:fd4dc129784e0c5335bd4e61dfcc4487499a013419e655cf2da1d091b7e0efdc"},
+ {file = "tomli-2.5.0-cp313-cp313-win_arm64.whl", hash = "sha256:69491c143d2fe063046e0301e62a810bed338fa4d1ce0fd870c27dc1e09b0d84"},
+ {file = "tomli-2.5.0-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:d3182ee2d887e507bd67319a0a61105d1dd33facc111329559a233b772c1a105"},
+ {file = "tomli-2.5.0-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:521345fd1f19d45b8df87657aaa38b6f2ca3800059fadf428e7ebf479a383646"},
+ {file = "tomli-2.5.0-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:6e95c7614e705bfe2b04b27aa124adec59752d15813df37e2156747cab3a006b"},
+ {file = "tomli-2.5.0-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:7ac2027d37c3afbdf4bdd377f2676f6f1d2122a5be1f1137b49dced590b37e75"},
+ {file = "tomli-2.5.0-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:c414be4ed9d3cac80c42e348fa5a956117d1a48227f48026e31f59cb4a7671eb"},
+ {file = "tomli-2.5.0-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:9b03d7dc168353b4132965bde20feceabaa470e570c6f59660dfae59b1f9eeb3"},
+ {file = "tomli-2.5.0-cp314-cp314-win32.whl", hash = "sha256:6f041843c4d3a37245c0c056fd955b186bf8b1fb85690cbe40b81230891dc34b"},
+ {file = "tomli-2.5.0-cp314-cp314-win_amd64.whl", hash = "sha256:f4b653094e18f9031102d3a1da5c729c8f222d85225b18037dac621695e46e1a"},
+ {file = "tomli-2.5.0-cp314-cp314-win_arm64.whl", hash = "sha256:3f89d10c1ff6a38d992c27fc8a4816af71a909e08a40ec66934240b1e74347c3"},
+ {file = "tomli-2.5.0-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:e9e15b4a6c7dd6b85b5fbab29488a73f1f70de516942308daa266bf0e0aeb0d4"},
+ {file = "tomli-2.5.0-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:e12bbcd32897272fb05929110362ae9ff4c1b9bb26bd9e971e71dcd3275b4c3d"},
+ {file = "tomli-2.5.0-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:20aa36de8f2cf87237143bc1fa1aae8d6612c09118f4da21c6a684db5dd1f6f9"},
+ {file = "tomli-2.5.0-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:22185fad8a1e622f064e78008018a0dd3323550dcb479cb7a1d296888d74024f"},
+ {file = "tomli-2.5.0-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:984012f71908165449a951de2050d52f276bfe3aa5d5f570f63ddad814370374"},
+ {file = "tomli-2.5.0-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:f79203b3965b4000e91808aaa7c040206093f2b8bf86f455982f2274c9ccf442"},
+ {file = "tomli-2.5.0-cp314-cp314t-win32.whl", hash = "sha256:91294a9fb94a75542f6e46e4a2ae709bd8d9b51134098cae5cf3bea5478b6d03"},
+ {file = "tomli-2.5.0-cp314-cp314t-win_amd64.whl", hash = "sha256:f15e3e0b835a6d68b10c86bf80a3149780498d6911c93c3ffd1861d19f9200f1"},
+ {file = "tomli-2.5.0-cp314-cp314t-win_arm64.whl", hash = "sha256:6664b7ae7af7294256c53960a6103077f4914cec8ff98479c352f622c6f6b2f0"},
+ {file = "tomli-2.5.0-cp315-cp315-macosx_10_15_x86_64.whl", hash = "sha256:a525685c2f97da40762b8695eb7aa0af4c8344ca1905c73e4e29cb04d34607dc"},
+ {file = "tomli-2.5.0-cp315-cp315-macosx_11_0_arm64.whl", hash = "sha256:9dbb18c1cfb2f6517942fc9314437f66aa06d94436ffb1f06102ef3572f35276"},
+ {file = "tomli-2.5.0-cp315-cp315-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:752e8b1aa6a4367ef8bf6a1a1e005540f7ed055ba36d7193796812ca5404eb52"},
+ {file = "tomli-2.5.0-cp315-cp315-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:c47300f9bf791808f77d82747691c4bb09cb14bdf3060cca99b42cdc4361d5a7"},
+ {file = "tomli-2.5.0-cp315-cp315-musllinux_1_2_aarch64.whl", hash = "sha256:19b0dd8749f4ea2f112c5fcfb3c5248390c899d7e2e173f1d91abee1fa0ff391"},
+ {file = "tomli-2.5.0-cp315-cp315-musllinux_1_2_x86_64.whl", hash = "sha256:57b1c3b01fab802e2899bc3d168dca320e14165e2fd9fd584760fb4ca5826859"},
+ {file = "tomli-2.5.0-cp315-cp315-win32.whl", hash = "sha256:667e521b37a6c5ccaa044202c235b530f90177ffe2cd4a64ecc213c7dd535feb"},
+ {file = "tomli-2.5.0-cp315-cp315-win_amd64.whl", hash = "sha256:d747252933c8a65ef6bd8da0fbb7ce28a90eb6119d8cd00772cd528aa07b68d5"},
+ {file = "tomli-2.5.0-cp315-cp315-win_arm64.whl", hash = "sha256:75dbcde8751b0a960aa3de173aa5e894d590755c6d7758b7e774c06f1dc3cbdd"},
+ {file = "tomli-2.5.0-cp315-cp315t-macosx_10_15_x86_64.whl", hash = "sha256:2419c2a189551987b59d80e63ec355671283336f41c6b9b89462df679c7d0c57"},
+ {file = "tomli-2.5.0-cp315-cp315t-macosx_11_0_arm64.whl", hash = "sha256:0dc598040da8d42cf20f0be588ed7004f46db12a0ac6c32e03a59dccedaaadcd"},
+ {file = "tomli-2.5.0-cp315-cp315t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:49096930c8d886c9bbdab62d2d0d17ce823ddeea522309a190b36245d5b49e01"},
+ {file = "tomli-2.5.0-cp315-cp315t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:b8ade5023067f99fe72b88accd30d0ea05a158e9e32a11f124e731ea9695313f"},
+ {file = "tomli-2.5.0-cp315-cp315t-musllinux_1_2_aarch64.whl", hash = "sha256:b69564772b5c8f22ea5f498dff08cfa825045b4d4c4400529000bdf818aa3b2a"},
+ {file = "tomli-2.5.0-cp315-cp315t-musllinux_1_2_x86_64.whl", hash = "sha256:8ff3a2ca028c7eee0c777f9a092038d0a594a9fa04e215f929a22c329e2cb142"},
+ {file = "tomli-2.5.0-cp315-cp315t-win32.whl", hash = "sha256:62fc1bc8eb03e3a9cadfca713d65614ed8e09d974a283295ffe3a831976b4dc5"},
+ {file = "tomli-2.5.0-cp315-cp315t-win_amd64.whl", hash = "sha256:f3fcbc57b1791fa6cbe5d8434179d51de12be1a4811469529f47f6e7487a2571"},
+ {file = "tomli-2.5.0-cp315-cp315t-win_arm64.whl", hash = "sha256:d2ba24db8a9376921b5e87b4762b9adb0f3f1deaea68f2b8b0bb2c11efb9c3e7"},
+ {file = "tomli-2.5.0-py3-none-any.whl", hash = "sha256:32a7b79ac57a2e83670ce329ccf675798bc5a2094783a63676866b70503f2e2b"},
+ {file = "tomli-2.5.0.tar.gz", hash = "sha256:264507556cd8b8c8e7c6ee037cdf443a463f03f4c958e57195e3d369711b8ff6"},
]
[[package]]
diff --git a/pyproject.toml b/pyproject.toml
index 786103ad..2aa101e8 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -4,7 +4,7 @@ dynamic = ["version"]
[tool.poetry]
name = "webflow"
-version = "2.0.0"
+version = "2.0.1"
description = ""
readme = "README.md"
authors = []
diff --git a/reference.md b/reference.md
index fbfbd16e..814c3c88 100644
--- a/reference.md
+++ b/reference.md
@@ -79,7 +79,9 @@ client.token.authorized_by()
Information about the authorization token
-Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients).
+Access to this endpoint requires a bearer token from either a [Data Client App](/data/docs/data-clients/getting-started), a [Workspace token](/data/reference/authentication/workspace-token), or a [Site token](/data/reference/authentication/site-token).
+
+The `application` object is only returned for tokens issued to an OAuth app. For tokens without an OAuth app, such as Site and Workspace API tokens (`grantType: client_credentials`), the response omits `application`.
@@ -126,6 +128,76 @@ client.token.introspect()
+
+
+
+
+## Workspaces
+client.workspaces.list() -> Workspaces
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+List the workspaces the token can access, including each workspace's ID. Use this endpoint to find the `workspace_id` that other workspace endpoints require.
+
+The response includes the workspaces granted to the token, plus the workspace that owns each site granted to the token. It returns only active workspaces (not archived, deleted, or draft) and isn't paginated.
+
+This endpoint supports workspace API tokens and Data Client apps.
+
+Required scope | `workspace:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.workspaces.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
-
-**workspace_id:** `str` — Unique identifier for a Workspace
+**workspace_id:** `str` — Unique identifier for a Workspace. Find it with [List Workspaces](/data/reference/enterprise/workspace-management/list) (workspace API tokens and Data Client apps), or with `authorization.authorizedTo.workspaceIds` from [Get Authorization Info](/data/reference/token/introspect). With a site token, read `workspaceId` from [Get Site](/data/reference/sites/get).
@@ -630,10 +702,15 @@ client.sites.get_custom_domain(
-
-Publishes a site to one or more more domains.
+Publishes a site or an individual page to one or more domains.
+If multiple individual pages are published to staging, publishing from staging to production publishes all staged changes.
To publish to a specific custom domain, use the domain IDs from the [Get Custom Domains](/data/reference/sites/get-custom-domain) endpoint.
+You must include at least one of the `customDomains` or `publishToWebflowSubdomain` properties in the request body.
+
+To publish an individual page instead of the entire site, provide the ID of the page in the `pageId` parameter.
+
This endpoint has a specific rate limit of one successful publish queue per minute.
Required scope | `sites:write`
@@ -706,6 +783,88 @@ client.sites.publish(
-
+**page_id:** `typing.Optional[str]` — The ID of the page to publish
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+
+
+## Optimize
+client.optimize.list() -> OptimizeReferenceListResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Lists the `optimizeId` values the provided access token can access, and the resource each one comes from, such as a Webflow site or a non-Webflow site. Use an `optimizeId` with the other Optimize endpoints.
+
+Results are sorted by `optimizeId` and aren't paginated.
+
+Webflow sites accept OAuth app tokens and Site API tokens. Non-Webflow sites that use Optimize accept only OAuth app tokens, including tokens authorized for a whole workspace.
+
+This endpoint requires a Webflow site with the Optimize add-on, or a non-Webflow site that uses Optimize.
+
+Each access token can have one Optimize request in flight at a time, across all Optimize endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.optimize.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -1072,6 +1231,119 @@ client.collections.delete(
+
+
+
client.collections.patch(...) -> Collection
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Update a collection's display name, singular name, slug, or field groups.
+
+**Field group rules:**
+- A collection can have a maximum of 50 field groups
+- Each `displayName` must be unique across all field groups in the collection
+- Each `fieldId` must be unique across all field groups in the collection
+- Ecommerce collections do not support field groups
+
+Required scope | `cms:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.collections.patch(
+ collection_id="580e63fc8c9a982ac9b8b745",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_id:** `str` — Unique identifier for a Collection
+
+
+
+
+
+-
+
+**display_name:** `typing.Optional[str]` — Name given to the Collection
+
+
+
+
+
+-
+
+**singular_name:** `typing.Optional[str]` — The name of one Item in Collection (e.g. ”Blog Post” if the Collection is called “Blog Posts”)
+
+
+
+
+
+-
+
+**slug:** `typing.Optional[str]` — Slug of Collection in Site URL structure
+
+
+
+
+
+-
+
+**field_groups:** `typing.Optional[typing.List[FieldGroup]]` — The list of field groups in the Collection. Replaces the existing field groups.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+-
+
+**translatable:** `typing.Optional[str]`
+
+Unique identifier for the secondary Locale you're translating **into**. Returns only content that hasn't been excluded from translation for that locale.
+
+This is independent of `localeId`, which selects which version of the content is returned. To fetch the source text to translate, request the primary locale's content and set `translatable` to the locale you're translating into:
+
+`?localeId={primary locale id}&translatable={target locale id}`
+
+Only exclusion rules scoped to manual translation are respected — rules scoped only to automatic translation don't affect this parameter's response.
+
+Omitting `translatable` returns the same response as if this parameter didn't exist. The value must be the id of one of the site's secondary locales — the primary locale id, or any other value, returns a `400` error. Requires translation exclusions to be enabled for the site; if they aren't, the request returns a `403` error.
+
+[Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
@@ -1352,7 +1645,7 @@ client.pages.update_page_settings(
Unique identifier for a specific Locale.
-[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
+[Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
@@ -1372,8 +1665,9 @@ Unique identifier for a specific Locale.
Slug for the page.
-
-**Note:** Updating slugs in secondary locales is only supported in Advanced and Enterprise localization add-on plans.
+**Note:** The slug field is ignored in the following cases — all other fields in the same request still apply:
+- The site's home page, collection template pages, and utility pages (e.g. 404, password, search).
+- For secondary locales, updating the slug requires an Advanced or Enterprise localization add-on plan.
@@ -1453,6 +1747,7 @@ client.pages.get_content(
locale_id="65427cf400e02b306eaa04a0",
limit=1,
offset=1,
+ translatable="65427cf400e02b306eaa04a0",
)
```
@@ -1481,7 +1776,7 @@ client.pages.get_content(
Unique identifier for a specific Locale.
-[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
+[Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
@@ -1505,8 +1800,28 @@ Unique identifier for a specific Locale.
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
+**translatable:** `typing.Optional[str]`
+
+Unique identifier for the secondary Locale you're translating **into**. Returns only content that hasn't been excluded from translation for that locale.
+
+This is independent of `localeId`, which selects which version of the content is returned. To fetch the source text to translate, request the primary locale's content and set `translatable` to the locale you're translating into:
+
+`?localeId={primary locale id}&translatable={target locale id}`
+
+Only exclusion rules scoped to manual translation are respected — rules scoped only to automatic translation don't affect this parameter's response.
+
+Omitting `translatable` returns the same response as if this parameter didn't exist. The value must be the id of one of the site's secondary locales — the primary locale id, or any other value, returns a `400` error. Requires translation exclusions to be enabled for the site; if they aren't, the request returns a `403` error.
+
+[Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
@@ -1790,6 +2105,7 @@ client.components.get_content(
branch_id="68026fa68ef6dc744c75b833",
limit=1,
offset=1,
+ translatable="65427cf400e02b306eaa04a0",
)
```
@@ -1826,7 +2142,7 @@ client.components.get_content(
Unique identifier for a specific Locale.
-[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
+[Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
@@ -1858,6 +2174,26 @@ Unique identifier for a specific Locale.
-
+**translatable:** `typing.Optional[str]`
+
+Unique identifier for the secondary Locale you're translating **into**. Returns only content that hasn't been excluded from translation for that locale.
+
+This is independent of `localeId`, which selects which version of the content is returned. To fetch the source text to translate, request the primary locale's content and set `translatable` to the locale you're translating into:
+
+`?localeId={primary locale id}&translatable={target locale id}`
+
+Only exclusion rules scoped to manual translation are respected — rules scoped only to automatic translation don't affect this parameter's response.
+
+Omitting `translatable` returns the same response as if this parameter didn't exist. The value must be the id of one of the site's secondary locales — the primary locale id, or any other value, returns a `400` error. Requires translation exclusions to be enabled for the site; if they aren't, the request returns a `403` error.
+
+[Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -1987,7 +2323,7 @@ client.components.update_content(
Unique identifier for a specific Locale.
-[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
+[Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
@@ -2061,6 +2397,7 @@ client.components.get_properties(
branch_id="68026fa68ef6dc744c75b833",
limit=1,
offset=1,
+ translatable="65427cf400e02b306eaa04a0",
)
```
@@ -2097,7 +2434,7 @@ client.components.get_properties(
Unique identifier for a specific Locale.
-[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
+[Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
@@ -2129,6 +2466,26 @@ Unique identifier for a specific Locale.
-
+**translatable:** `typing.Optional[str]`
+
+Unique identifier for the secondary Locale you're translating **into**. Returns only content that hasn't been excluded from translation for that locale.
+
+This is independent of `localeId`, which selects which version of the content is returned. To fetch the source text to translate, request the primary locale's content and set `translatable` to the locale you're translating into:
+
+`?localeId={primary locale id}&translatable={target locale id}`
+
+Only exclusion rules scoped to manual translation are respected — rules scoped only to automatic translation don't affect this parameter's response.
+
+Omitting `translatable` returns the same response as if this parameter didn't exist. The value must be the id of one of the site's secondary locales — the primary locale id, or any other value, returns a `400` error. Requires translation exclusions to be enabled for the site; if they aren't, the request returns a `403` error.
+
+[Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -2244,7 +2601,7 @@ client.components.update_properties(
Unique identifier for a specific Locale.
-[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
+[Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
@@ -2291,6 +2648,8 @@ Get a list of scripts that have been registered to a site. A site can have a max
To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
+Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).
+
Required scope | `custom_code:read`
@@ -2370,6 +2729,8 @@ Register a hosted script to a site.
To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
+Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).
+
Required scope | `custom_code:write`
@@ -2493,6 +2854,8 @@ Register an inline script to a site. Inline scripts are limited to 2000 characte
To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
+Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).
+
Required scope | `custom_code:write`
@@ -2637,8 +3000,10 @@ client = Webflow(
client.assets.list(
site_id="580e63e98c9a982ac9b8b741",
+ locale_id="65427cf400e02b306eaa04a0",
offset=1,
limit=1,
+ folder_id="folderId",
)
```
@@ -2663,6 +3028,18 @@ client.assets.list(
-
+**locale_id:** `typing.Optional[str]`
+
+Unique identifier for a specific Locale.
+
+[Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
+
+
+
+
+-
+
**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
@@ -2679,6 +3056,17 @@ client.assets.list(
-
+**folder_id:** `typing.Optional[str]`
+
+Filter assets to those in the specified folder and all descendant folders.
+Must be a 24-character hex ObjectId.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -2840,6 +3228,7 @@ client = Webflow(
client.assets.get(
asset_id="580e63fc8c9a982ac9b8b745",
+ locale_id="65427cf400e02b306eaa04a0",
)
```
@@ -2864,6 +3253,18 @@ client.assets.get(
-
+**locale_id:** `typing.Optional[str]`
+
+Unique identifier for a specific Locale.
+
+[Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -2990,6 +3391,7 @@ client = Webflow(
client.assets.update(
asset_id="580e63fc8c9a982ac9b8b745",
+ locale_id="65427cf400e02b306eaa04a0",
)
```
@@ -3014,7 +3416,19 @@ client.assets.update(
-
-**locale_id:** `typing.Optional[str]` — Unique identifier for a specific locale. Applicable, when using localization.
+**locale_id:** `typing.Optional[str]`
+
+Unique identifier for a specific Locale.
+
+[Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
+
+
+
+
+-
+
+**display_name:** `typing.Optional[str]` — A human readable name for the asset. This value is not localizable.
@@ -3022,7 +3436,7 @@ client.assets.update(
-
-**display_name:** `typing.Optional[str]` — A human readable name for the asset
+**alt_text:** `typing.Optional[str]` — Alternate text describing the image
@@ -3284,8 +3698,8 @@ client.assets.get_folder(
-## Webhooks
-client.webhooks.list(...) -> WebhookList
+## Custom Fonts
+client.custom_fonts.list(...) -> CustomFonts
-
@@ -3297,7 +3711,7 @@ client.assets.get_folder(
-
-List all App-created Webhooks registered for a given site
+List the custom fonts uploaded to a site.
Required scope | `sites:read`
@@ -3322,8 +3736,10 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.webhooks.list(
+client.custom_fonts.list(
site_id="580e63e98c9a982ac9b8b741",
+ offset=1,
+ limit=1,
)
```
@@ -3348,6 +3764,22 @@ client.webhooks.list(
-
+**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
+
+
+
+
+
+-
+
+**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -3360,7 +3792,7 @@ client.webhooks.list(
client.webhooks.create(...) -> Webhook
+client.custom_fonts.create(...) -> CustomFontCreateResponse
-
@@ -3372,11 +3804,14 @@ client.webhooks.list(
-
-Create a new Webhook.
+Register a custom font on a site and get a presigned S3 URL to upload the font binary.
-Limit of 75 registrations per `triggerType`, per site.
+The response includes a `customFont` object and an `upload` object. Use the `upload.url` and `upload.fields`
+to POST the font binary directly to S3 as `multipart/form-data`. The binary must go in a field named `file`
+and must be the last field in the form (an AWS S3 requirement). S3 returns `201 Created` on a successful upload.
+
+To learn more, see [Custom fonts](/data/docs/custom-fonts).
-Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients).
Required scope | `sites:write`
@@ -3394,22 +3829,20 @@ Required scope | `sites:write`
```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
-import datetime
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.webhooks.create(
- site_id_="580e63e98c9a982ac9b8b741",
- id="582266e0cd48de0f0e3c6d8b",
- trigger_type="form_submission",
- url="https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f",
- workspace_id="4f4e46fd476ea8c507000001",
- site_id="562ac0395358780a1f5e6fbd",
- last_triggered=datetime.datetime.fromisoformat("2023-02-08T23:59:28+00:00"),
- created_on=datetime.datetime.fromisoformat("2022-11-08T23:59:28+00:00"),
+client.custom_fonts.create(
+ site_id="580e63e98c9a982ac9b8b741",
+ file_name="AcmeSans-Regular.woff2",
+ file_hash="3c7d87c9575702bc3b1e991f4d3c638e",
+ font_family="Acme Sans",
+ weight=400,
+ italic=False,
+ font_display="auto",
)
```
@@ -3434,7 +3867,55 @@ client.webhooks.create(
-
-**request:** `Webhook`
+**file_name:** `str` — File name including extension. Accepted extensions are `.woff2`, `.woff`, `.ttf`, `.otf`, and `.eot`. Maximum 256 characters.
+
+
+
+
+
+-
+
+**file_hash:** `str` — Lowercase hex MD5 hash of the font binary (exactly 32 characters)
+
+
+
+
+
+-
+
+**font_family:** `str` — The CSS font-family name (1-256 characters). Commas are stripped server-side.
+
+
+
+
+
+-
+
+**weight:** `int` — CSS font-weight value (1-1000)
+
+
+
+
+
+-
+
+**italic:** `bool` — Whether the font is italic
+
+
+
+
+
+-
+
+**font_display:** `CustomFontsCreateRequestFontDisplay` — CSS font-display value
+
+
+
+
+
+-
+
+**axes:** `typing.Optional[typing.List[CustomFontAxis]]` — Variable font axes. Omit or pass an empty array for static fonts.
@@ -3454,7 +3935,7 @@ client.webhooks.create(
client.webhooks.get(...) -> Webhook
+client.custom_fonts.get(...) -> CustomFontsGetResponse
-
@@ -3466,9 +3947,9 @@ client.webhooks.create(
-
-Get a specific Webhook instance
+Get details about a custom font on a site.
-Required scope: `sites:read`
+Required scope | `sites:read`
@@ -3491,8 +3972,9 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.webhooks.get(
- webhook_id="580e64008c9a982ac9b8b754",
+client.custom_fonts.get(
+ site_id="580e63e98c9a982ac9b8b741",
+ font_id="66f3a1b2c4d5e6f7a8b9c0d1",
)
```
@@ -3509,7 +3991,15 @@ client.webhooks.get(
-
-**webhook_id:** `str` — Unique identifier for a Webhook
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**font_id:** `str` — Unique identifier for a custom font on a site
@@ -3529,7 +4019,7 @@ client.webhooks.get(
client.webhooks.delete(...)
+client.custom_fonts.delete(...)
-
@@ -3541,9 +4031,9 @@ client.webhooks.get(
-
-Remove a Webhook
+Delete a custom font from a site.
-Required scope: `sites:read`
+Required scope | `sites:write`
@@ -3566,8 +4056,9 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.webhooks.delete(
- webhook_id="580e64008c9a982ac9b8b754",
+client.custom_fonts.delete(
+ site_id="580e63e98c9a982ac9b8b741",
+ font_id="66f3a1b2c4d5e6f7a8b9c0d1",
)
```
@@ -3584,7 +4075,15 @@ client.webhooks.delete(
-
-**webhook_id:** `str` — Unique identifier for a Webhook
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**font_id:** `str` — Unique identifier for a custom font on a site
@@ -3604,8 +4103,7 @@ client.webhooks.delete(
client.forms.list(...) -> FormList
+client.custom_fonts.update(...) -> CustomFontsUpdateResponse
-
@@ -3617,9 +4115,12 @@ client.webhooks.delete(
-
-List forms for a given site.
+Update the metadata of a custom font. The font binary is not changed by this endpoint.
+To replace the binary, use [Replace custom font file](#operation/replace-custom-font-file).
-Required scope | `forms:read`
+The request body must include at least one of `fontFamily`, `weight`, `italic`, or `fontDisplay`.
+
+Required scope | `sites:write`
@@ -3642,10 +4143,9 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.forms.list(
+client.custom_fonts.update(
site_id="580e63e98c9a982ac9b8b741",
- limit=1,
- offset=1,
+ font_id="66f3a1b2c4d5e6f7a8b9c0d1",
)
```
@@ -3670,7 +4170,7 @@ client.forms.list(
-
-**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+**font_id:** `str` — Unique identifier for a custom font on a site
@@ -3678,7 +4178,31 @@ client.forms.list(
-
-**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
+**font_family:** `typing.Optional[str]` — The CSS font-family name (1-256 characters)
+
+
+
+
+
+-
+
+**weight:** `typing.Optional[int]` — CSS font-weight value (1-1000)
+
+
+
+
+
+-
+
+**italic:** `typing.Optional[bool]` — Whether the font is italic
+
+
+
+
+
+-
+
+**font_display:** `typing.Optional[CustomFontsUpdateRequestFontDisplay]` — CSS font-display value
@@ -3698,7 +4222,7 @@ client.forms.list(
client.forms.get(...) -> Form
+client.custom_fonts.replace_file(...) -> CustomFontCreateResponse
-
@@ -3710,9 +4234,14 @@ client.forms.list(
-
-Get information about a given form.
+Replace the binary of an existing custom font while preserving its ID and any references to it.
+The upload handshake is identical to [Create custom font](#operation/create-custom-font).
-Required scope | `forms:read`
+If the existing font has a non-empty `axes` array (a variable font), you must include an `axes` field
+in the request. Send `axes: []` to declare that the new binary is a static font, or send the new variable
+axes to declare it is still variable. Omitting `axes` when the existing font is variable returns `400`.
+
+Required scope | `sites:write`
@@ -3735,8 +4264,11 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.forms.get(
- form_id="580e63e98c9a982ac9b8b741",
+client.custom_fonts.replace_file(
+ site_id="580e63e98c9a982ac9b8b741",
+ font_id="66f3a1b2c4d5e6f7a8b9c0d1",
+ file_name="AcmeSans-Regular-v2.woff2",
+ file_hash="3c7d87c9575702bc3b1e991f4d3c638e",
)
```
@@ -3753,7 +4285,7 @@ client.forms.get(
-
-**form_id:** `str` — Unique identifier for a Form
+**site_id:** `str` — Unique identifier for a Site
@@ -3761,39 +4293,79 @@ client.forms.get(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**font_id:** `str` — Unique identifier for a custom font on a site
-
-
+
+-
+**file_name:** `str` — File name including extension. Accepted extensions are `.woff2`, `.woff`, `.ttf`, `.otf`, and `.eot`. Maximum 256 characters.
+
-client.forms.list_submissions(...) -> FormSubmissionList
-
-#### 📝 Description
+**file_hash:** `str` — Lowercase hex MD5 hash of the font binary (exactly 32 characters)
+
+
+
-
+**axes:** `typing.Optional[typing.List[CustomFontAxis]]` — Variable font axes for the replacement binary. Required when the existing font has a non-empty `axes` array.
+
+
+
+
-
-List form submissions for a given form
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
-
- When a form is used in a component definition, each instance of the form is considered a unique form.
- To get a combined list of submissions for a form that appears across multiple component instances, use the [List Form Submissions by Site](/data/reference/forms/form-submissions/list-submissions-by-site) endpoint.
-
+
+
+
-Required scope | `forms:read`
+client.custom_fonts.batch_create(...) -> CustomFontBatchCreateResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Register 1–25 custom fonts in a single request and get a presigned S3 URL for each one.
+This collapses the registration step for a whole font family (for example, Regular, Bold,
+Italic, and Bold Italic) into one rate-limited request.
+
+Registration is batched, but the binary uploads are not: the response contains one `upload`
+object per registered font, and you must POST each font binary to its own presigned S3 URL
+exactly as you would for [Create custom font](#operation/create-custom-font). The Webflow API
+server never receives the raw font bytes.
+
+The response is `200 OK` for a valid request body. Per-font results are reported in the
+`created` and `failed` arrays. If the site's font limit is reached partway through the batch,
+the fonts that still fit are registered and returned in `created`, while the rest appear in
+`failed` with `name: "FontLimitReached"` — valid fonts are never discarded because a later
+font in the same batch could not be registered. Each presigned URL expires approximately
+15 minutes after issuance, so upload the binaries promptly.
+
+Required scope | `sites:write`
@@ -3810,16 +4382,25 @@ Required scope | `forms:read`
```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
+from webflow.custom_fonts import CustomFontBatchCreateRequestItemsItem
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.forms.list_submissions(
- form_id="580e63e98c9a982ac9b8b741",
- offset=1,
- limit=1,
+client.custom_fonts.batch_create(
+ site_id="580e63e98c9a982ac9b8b741",
+ items=[
+ CustomFontBatchCreateRequestItemsItem(
+ file_name="AcmeSans-Regular.woff2",
+ file_hash="3c7d87c9575702bc3b1e991f4d3c638e",
+ font_family="Acme Sans",
+ weight=400,
+ italic=False,
+ font_display="auto",
+ )
+ ],
)
```
@@ -3836,15 +4417,7 @@ client.forms.list_submissions(
-
-**form_id:** `str` — Unique identifier for a Form
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
+**site_id:** `str` — Unique identifier for a Site
@@ -3852,7 +4425,7 @@ client.forms.list_submissions(
-
-**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+**items:** `typing.List[CustomFontBatchCreateRequestItemsItem]` — The custom fonts to register. Each item uses the same shape as the single-font create request.
@@ -3872,7 +4445,7 @@ client.forms.list_submissions(
client.forms.get_submission(...) -> FormSubmission
+client.custom_fonts.batch_delete(...) -> CustomFontBatchDeleteResponse
-
@@ -3884,9 +4457,14 @@ client.forms.list_submissions(
-
-Get information about a given form submissio.
+Delete 1-100 custom fonts in a single request. The response is always `200 OK` for a valid request body.
+Per-font results are reported in the `deleted` and `failed` arrays.
-Required scope | `forms:read`
+The endpoint is idempotent: fonts that do not exist appear in `failed` with `name: "NotFound"` rather than
+failing the entire request. You can safely retry a partial failure by re-sending only the IDs that did not
+appear in `deleted`.
+
+Required scope | `sites:write`
@@ -3903,14 +4481,20 @@ Required scope | `forms:read`
```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
+from webflow.custom_fonts import CustomFontBatchDeleteRequestItemsItem
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.forms.get_submission(
- form_submission_id="580e63e98c9a982ac9b8b741",
+client.custom_fonts.batch_delete(
+ site_id="580e63e98c9a982ac9b8b741",
+ items=[
+ CustomFontBatchDeleteRequestItemsItem(
+ id="66f3a1b2c4d5e6f7a8b9c0d1",
+ )
+ ],
)
```
@@ -3927,7 +4511,15 @@ client.forms.get_submission(
-
-**form_submission_id:** `str` — Unique identifier for a Form Submission
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**items:** `typing.List[CustomFontBatchDeleteRequestItemsItem]`
@@ -3947,7 +4539,8 @@ client.forms.get_submission(
client.forms.delete_submission(...)
+## Webhooks
+client.webhooks.list(...) -> WebhookList
-
@@ -3959,10 +4552,9 @@ client.forms.get_submission(
-
-Delete a form submission
-
+List all App-created Webhooks registered for a given site
-Required scope | `forms:write`
+Required scope | `sites:read`
@@ -3985,8 +4577,8 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.forms.delete_submission(
- form_submission_id="580e63e98c9a982ac9b8b741",
+client.webhooks.list(
+ site_id="580e63e98c9a982ac9b8b741",
)
```
@@ -4003,7 +4595,7 @@ client.forms.delete_submission(
-
-**form_submission_id:** `str` — Unique identifier for a Form Submission
+**site_id:** `str` — Unique identifier for a Site
@@ -4023,7 +4615,7 @@ client.forms.delete_submission(
client.forms.update_submission(...) -> FormSubmission
+client.webhooks.create(...) -> Webhook
-
@@ -4035,9 +4627,12 @@ client.forms.delete_submission(
-
-Update hidden fields on a form submission
+Create a new Webhook.
-Required scope | `forms:write`
+Limit of 75 registrations per `triggerType`, per site.
+
+Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/data-clients/getting-started).
+Required scope | `sites:write`
@@ -4054,14 +4649,22 @@ Required scope | `forms:write`
```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
+import datetime
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.forms.update_submission(
- form_submission_id="580e63e98c9a982ac9b8b741",
+client.webhooks.create(
+ site_id_="580e63e98c9a982ac9b8b741",
+ id="582266e0cd48de0f0e3c6d8b",
+ trigger_type="form_submission",
+ url="https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f",
+ workspace_id="4f4e46fd476ea8c507000001",
+ site_id="562ac0395358780a1f5e6fbd",
+ last_triggered=datetime.datetime.fromisoformat("2023-02-08T23:59:28+00:00"),
+ created_on=datetime.datetime.fromisoformat("2022-11-08T23:59:28+00:00"),
)
```
@@ -4078,7 +4681,7 @@ client.forms.update_submission(
-
-**form_submission_id:** `str` — Unique identifier for a Form Submission
+**site_id:** `str` — Unique identifier for a Site
@@ -4086,7 +4689,7 @@ client.forms.update_submission(
-
-**form_submission_data:** `typing.Optional[typing.Dict[str, typing.Any]]` — An existing **hidden field** defined on the form schema, and the corresponding value to set
+**request:** `Webhook`
@@ -4106,8 +4709,7 @@ client.forms.update_submission(
client.products.list(...) -> ProductAndSkUsList
+client.webhooks.get(...) -> Webhook
-
@@ -4119,12 +4721,9 @@ client.forms.update_submission(
-
-Retrieve all products for a site.
-
-Use `limit` and `offset` to page through all products with subsequent requests. All SKUs for each product
-will also be fetched and returned. The `limit`, `offset` and `total` values represent Products only and do not include any SKUs.
+Get a specific Webhook instance
-Required scope | `ecommerce:read`
+Required scope: `sites:read`
@@ -4147,10 +4746,8 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.products.list(
- site_id="580e63e98c9a982ac9b8b741",
- offset=1,
- limit=1,
+client.webhooks.get(
+ webhook_id="580e64008c9a982ac9b8b754",
)
```
@@ -4167,23 +4764,7 @@ client.products.list(
-
-**site_id:** `str` — Unique identifier for a Site
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+**webhook_id:** `str` — Unique identifier for a Webhook
@@ -4203,7 +4784,7 @@ client.products.list(
client.products.create(...) -> ProductAndSkUs
+client.webhooks.delete(...)
-
@@ -4215,16 +4796,9 @@ client.products.list(
-
-Create a new ecommerce product and defaultSKU. A product, at minimum, must have a single SKU.
-
-To create a product with multiple SKUs:
- - First, create a list of `sku-properties`, also known as [product options](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants). For example, a T-shirt product may have a "color" `sku-property`, with a list of enum values: red, yellow, and blue, another `sku-property` may be "size", with a list of enum values: small, medium, and large.
- - Once, a product is created with a list of `sku-properties`, Webflow will create a **default SKU**, which is always a combination of the first `enum` values of each `sku-property`. (e.g. Small - Red - T-Shirt)
- - After creation, you can create additional SKUs for the product, using the [Create SKUs endpoint.](/data/reference/ecommerce/products/create-sku)
-
-Upon creation, the default product type will be `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.
+Remove a Webhook
-Required scope | `ecommerce:write`
+Required scope: `sites:read`
@@ -4239,81 +4813,16 @@ Required scope | `ecommerce:write`
-
```python
-from webflow import Webflow, ProductFieldData, SkuPropertyList, SkuPropertyListEnumItem, SkuFieldData, SkuFieldDataPrice
+from webflow import Webflow
from webflow.environment import WebflowEnvironment
-from webflow.products import ProductSkuCreateProduct, ProductSkuCreateSku
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.products.create(
- site_id="580e63e98c9a982ac9b8b741",
- publish_status="staging",
- product=ProductSkuCreateProduct(
- field_data=ProductFieldData(
- name="Colorful T-shirt",
- slug="colorful-t-shirt",
- description="Our best-selling t-shirt available in multiple colors and sizes",
- sku_properties=[
- SkuPropertyList(
- id="color",
- name="Color",
- enum=[
- SkuPropertyListEnumItem(
- id="red",
- name="Red",
- slug="red",
- ),
- SkuPropertyListEnumItem(
- id="yellow",
- name="Yellow",
- slug="yellow",
- ),
- SkuPropertyListEnumItem(
- id="blue",
- name="Blue",
- slug="blue",
- )
- ],
- ),
- SkuPropertyList(
- id="size",
- name="Size",
- enum=[
- SkuPropertyListEnumItem(
- id="small",
- name="Small",
- slug="small",
- ),
- SkuPropertyListEnumItem(
- id="medium",
- name="Medium",
- slug="medium",
- ),
- SkuPropertyListEnumItem(
- id="large",
- name="Large",
- slug="large",
- )
- ],
- )
- ],
- ),
- ),
- sku=ProductSkuCreateSku(
- field_data=SkuFieldData(
- name="Colorful T-shirt - Red Small",
- slug="colorful-t-shirt-red-small",
- price=SkuFieldDataPrice(
- value=2499,
- unit="USD",
- currency="USD",
- ),
- main_image="https://rocketamp-sample-store.myshopify.com/cdn/shop/products/Gildan_2000_Antique_Cherry_Red_Front_1024x1024.jpg?v=1527232987",
- ),
- ),
+client.webhooks.delete(
+ webhook_id="580e64008c9a982ac9b8b754",
)
```
@@ -4330,7 +4839,7 @@ client.products.create(
-
-**site_id:** `str` — Unique identifier for a Site
+**webhook_id:** `str` — Unique identifier for a Webhook
@@ -4338,58 +4847,34 @@ client.products.create(
-
-**product:** `ProductSkuCreateProduct`
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**sku:** `ProductSkuCreateSku`
-
+client.forms.list(...) -> FormList
-
-**publish_status:** `typing.Optional[PublishStatus]`
-
-
-
+#### 📝 Description
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.products.get(...) -> ProductAndSkUs
-
--
-
-#### 📝 Description
-
-
-
--
-
-Retrieve a single product by its ID. All of its SKUs will also be
-retrieved.
+List forms for a given site.
-Required scope | `ecommerce:read`
+Required scope | `forms:read`
@@ -4412,9 +4897,10 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.products.get(
+client.forms.list(
site_id="580e63e98c9a982ac9b8b741",
- product_id="580e63fc8c9a982ac9b8b745",
+ limit=1,
+ offset=1,
)
```
@@ -4439,7 +4925,15 @@ client.products.get(
-
-**product_id:** `str` — Unique identifier for a Product
+**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+
+
+
+
+
+-
+
+**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
@@ -4459,7 +4953,7 @@ client.products.get(
client.products.update(...) -> Product
+client.forms.get(...) -> Form
-
@@ -4471,11 +4965,9 @@ client.products.get(
-
-Update an existing Product.
-
-Updating an existing Product will set the product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.
+Get information about a given form.
-Required scope | `ecommerce:write`
+Required scope | `forms:read`
@@ -4498,9 +4990,8 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.products.update(
- site_id="580e63e98c9a982ac9b8b741",
- product_id="580e63fc8c9a982ac9b8b745",
+client.forms.get(
+ form_id="580e63e98c9a982ac9b8b741",
)
```
@@ -4517,39 +5008,7 @@ client.products.update(
-
-**site_id:** `str` — Unique identifier for a Site
-
-
-
-
-
--
-
-**product_id:** `str` — Unique identifier for a Product
-
-
-
-
-
--
-
-**publish_status:** `typing.Optional[PublishStatus]`
-
-
-
-
-
--
-
-**product:** `typing.Optional[Product]`
-
-
-
-
-
--
-
-**sku:** `typing.Optional[Sku]`
+**form_id:** `str` — Unique identifier for a Form
@@ -4569,7 +5028,7 @@ client.products.update(
client.products.create_sku(...) -> ProductsCreateSkuResponse
+client.forms.list_submissions(...) -> FormSubmissionList
-
@@ -4581,11 +5040,15 @@ client.products.update(
-
-Create additional SKUs to manage every [option and variant of your Product.](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants)
+List form submissions for a given form
-Creating SKUs through the API will set the product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.
+
+ When a form is used in a component definition, each instance of the form is considered a unique form.
-Required scope | `ecommerce:write`
+ To get a combined list of submissions for a form that appears across multiple component instances, use the [List Form Submissions by Site](/data/reference/forms/form-submissions/list-submissions-by-site) endpoint.
+
+
+Required scope | `forms:read`
@@ -4600,36 +5063,18 @@ Required scope | `ecommerce:write`
-
```python
-from webflow import Webflow, Sku, SkuFieldData, SkuFieldDataPrice
+from webflow import Webflow
from webflow.environment import WebflowEnvironment
-import datetime
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.products.create_sku(
- site_id="580e63e98c9a982ac9b8b741",
- product_id="580e63fc8c9a982ac9b8b745",
- skus=[
- Sku(
- id="66072fb71b89448912e2681c",
- cms_locale_id="653ad57de882f528b32e810e",
- last_published=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"),
- last_updated=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"),
- created_on=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"),
- field_data=SkuFieldData(
- name="Colorful T-shirt - Default",
- slug="colorful-t-shirt-default",
- price=SkuFieldDataPrice(
- value=2499,
- unit="USD",
- currency="USD",
- ),
- ),
- )
- ],
+client.forms.list_submissions(
+ form_id="580e63e98c9a982ac9b8b741",
+ offset=1,
+ limit=1,
)
```
@@ -4646,15 +5091,7 @@ client.products.create_sku(
-
-**site_id:** `str` — Unique identifier for a Site
-
-
-
-
-
--
-
-**product_id:** `str` — Unique identifier for a Product
+**form_id:** `str` — Unique identifier for a Form
@@ -4662,7 +5099,7 @@ client.products.create_sku(
-
-**skus:** `typing.List[Sku]` — An array of the SKU data your are adding
+**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
@@ -4670,7 +5107,7 @@ client.products.create_sku(
-
-**publish_status:** `typing.Optional[PublishStatus]`
+**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
@@ -4690,7 +5127,7 @@ client.products.create_sku(
client.products.update_sku(...) -> Sku
+client.forms.get_submission(...) -> FormSubmission
-
@@ -4702,11 +5139,9 @@ client.products.create_sku(
-
-Update a specified SKU.
-
-Updating an existing SKU will set the Product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.
+Get information about a given form submissio.
-Required scope | `ecommerce:write`
+Required scope | `forms:read`
@@ -4721,35 +5156,16 @@ Required scope | `ecommerce:write`
-
```python
-from webflow import Webflow, Sku, SkuFieldData, SkuFieldDataPrice
+from webflow import Webflow
from webflow.environment import WebflowEnvironment
-import datetime
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.products.update_sku(
- site_id="580e63e98c9a982ac9b8b741",
- product_id="580e63fc8c9a982ac9b8b745",
- sku_id="5e8518516e147040726cc415",
- sku=Sku(
- id="66072fb71b89448912e2681c",
- cms_locale_id="653ad57de882f528b32e810e",
- last_published=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"),
- last_updated=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"),
- created_on=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"),
- field_data=SkuFieldData(
- name="Colorful T-shirt - Default",
- slug="colorful-t-shirt-default",
- price=SkuFieldDataPrice(
- value=2499,
- unit="USD",
- currency="USD",
- ),
- ),
- ),
+client.forms.get_submission(
+ form_submission_id="580e63e98c9a982ac9b8b741",
)
```
@@ -4766,39 +5182,7 @@ client.products.update_sku(
-
-**site_id:** `str` — Unique identifier for a Site
-
-
-
-
-
--
-
-**product_id:** `str` — Unique identifier for a Product
-
-
-
-
-
--
-
-**sku_id:** `str` — Unique identifier for a SKU
-
-
-
-
-
--
-
-**sku:** `Sku`
-
-
-
-
-
--
-
-**publish_status:** `typing.Optional[PublishStatus]`
+**form_submission_id:** `str` — Unique identifier for a Form Submission
@@ -4818,8 +5202,7 @@ client.products.update_sku(
client.orders.list(...) -> OrderList
+client.forms.delete_submission(...)
-
@@ -4831,9 +5214,10 @@ client.products.update_sku(
-
-List all orders created for a given site.
+Delete a form submission
-Required scope | `ecommerce:read`
+
+Required scope | `forms:write`
@@ -4856,11 +5240,8 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.orders.list(
- site_id="580e63e98c9a982ac9b8b741",
- status="pending",
- offset=1,
- limit=1,
+client.forms.delete_submission(
+ form_submission_id="580e63e98c9a982ac9b8b741",
)
```
@@ -4877,31 +5258,7 @@ client.orders.list(
-
-**site_id:** `str` — Unique identifier for a Site
-
-
-
-
-
--
-
-**status:** `typing.Optional[OrdersListRequestStatus]` — Filter the orders by status
-
-
-
-
-
--
-
-**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+**form_submission_id:** `str` — Unique identifier for a Form Submission
@@ -4921,7 +5278,7 @@ client.orders.list(
client.orders.get(...) -> Order
+client.forms.update_submission(...) -> FormSubmission
-
@@ -4933,10 +5290,9 @@ client.orders.list(
-
-Retrieve a single product by its ID. All of its SKUs will also be
-retrieved.
+Update hidden fields on a form submission
-Required scope | `ecommerce:read`
+Required scope | `forms:write`
@@ -4959,9 +5315,8 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.orders.get(
- site_id="580e63e98c9a982ac9b8b741",
- order_id="5e8518516e147040726cc415",
+client.forms.update_submission(
+ form_submission_id="580e63e98c9a982ac9b8b741",
)
```
@@ -4978,7 +5333,7 @@ client.orders.get(
-
-**site_id:** `str` — Unique identifier for a Site
+**form_submission_id:** `str` — Unique identifier for a Form Submission
@@ -4986,7 +5341,7 @@ client.orders.get(
-
-**order_id:** `str` — Unique identifier for an Order
+**form_submission_data:** `typing.Optional[typing.Dict[str, typing.Any]]` — An existing **hidden field** defined on the form schema, and the corresponding value to set
@@ -5006,7 +5361,8 @@ client.orders.get(
client.orders.update(...) -> Order
+## Products
+client.products.list(...) -> ProductAndSkUsList
-
@@ -5018,11 +5374,12 @@ client.orders.get(
-
-This API lets you update the fields, `comment`, `shippingProvider`,
-and/or `shippingTracking` for a given order. All three fields can be
-updated simultaneously or independently.
+Retrieve all products for a site.
-Required scope | `ecommerce:write`
+Use `limit` and `offset` to page through all products with subsequent requests. All SKUs for each product
+will also be fetched and returned. The `limit`, `offset` and `total` values represent Products only and do not include any SKUs.
+
+Required scope | `ecommerce:read`
@@ -5045,9 +5402,10 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.orders.update(
+client.products.list(
site_id="580e63e98c9a982ac9b8b741",
- order_id="5e8518516e147040726cc415",
+ offset=1,
+ limit=1,
)
```
@@ -5072,31 +5430,7 @@ client.orders.update(
-
-**order_id:** `str` — Unique identifier for an Order
-
-
-
-
-
--
-
-**comment:** `typing.Optional[str]` — Arbitrary data for your records
-
-
-
-
-
--
-
-**shipping_provider:** `typing.Optional[str]` — Company or method used to ship order
-
-
-
-
-
--
-
-**shipping_tracking:** `typing.Optional[str]` — Tracking number for order shipment
+**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
@@ -5104,7 +5438,7 @@ client.orders.update(
-
-**shipping_tracking_url:** `typing.Optional[str]` — URL to track order shipment
+**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
@@ -5124,7 +5458,7 @@ client.orders.update(
client.orders.update_fulfill(...) -> Order
+client.products.create(...) -> ProductAndSkUs
-
@@ -5136,7 +5470,14 @@ client.orders.update(
-
-Updates an order's status to fulfilled
+Create a new ecommerce product and defaultSKU. A product, at minimum, must have a single SKU.
+
+To create a product with multiple SKUs:
+ - First, create a list of `sku-properties`, also known as [product options](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants). For example, a T-shirt product may have a "color" `sku-property`, with a list of enum values: red, yellow, and blue, another `sku-property` may be "size", with a list of enum values: small, medium, and large.
+ - Once, a product is created with a list of `sku-properties`, Webflow will create a **default SKU**, which is always a combination of the first `enum` values of each `sku-property`. (e.g. Small - Red - T-Shirt)
+ - After creation, you can create additional SKUs for the product, using the [Create SKUs endpoint.](/data/reference/ecommerce/products/create-sku)
+
+Upon creation, the default product type will be `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.
Required scope | `ecommerce:write`
@@ -5153,17 +5494,81 @@ Required scope | `ecommerce:write`
-
```python
-from webflow import Webflow
+from webflow import Webflow, ProductFieldData, SkuPropertyList, SkuPropertyListEnumItem, SkuFieldData, SkuFieldDataPrice
from webflow.environment import WebflowEnvironment
+from webflow.products import ProductSkuCreateProduct, ProductSkuCreateSku
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.orders.update_fulfill(
+client.products.create(
site_id="580e63e98c9a982ac9b8b741",
- order_id="5e8518516e147040726cc415",
+ publish_status="staging",
+ product=ProductSkuCreateProduct(
+ field_data=ProductFieldData(
+ name="Colorful T-shirt",
+ slug="colorful-t-shirt",
+ description="Our best-selling t-shirt available in multiple colors and sizes",
+ sku_properties=[
+ SkuPropertyList(
+ id="color",
+ name="Color",
+ enum=[
+ SkuPropertyListEnumItem(
+ id="red",
+ name="Red",
+ slug="red",
+ ),
+ SkuPropertyListEnumItem(
+ id="yellow",
+ name="Yellow",
+ slug="yellow",
+ ),
+ SkuPropertyListEnumItem(
+ id="blue",
+ name="Blue",
+ slug="blue",
+ )
+ ],
+ ),
+ SkuPropertyList(
+ id="size",
+ name="Size",
+ enum=[
+ SkuPropertyListEnumItem(
+ id="small",
+ name="Small",
+ slug="small",
+ ),
+ SkuPropertyListEnumItem(
+ id="medium",
+ name="Medium",
+ slug="medium",
+ ),
+ SkuPropertyListEnumItem(
+ id="large",
+ name="Large",
+ slug="large",
+ )
+ ],
+ )
+ ],
+ ),
+ ),
+ sku=ProductSkuCreateSku(
+ field_data=SkuFieldData(
+ name="Colorful T-shirt - Red Small",
+ slug="colorful-t-shirt-red-small",
+ price=SkuFieldDataPrice(
+ value=2499,
+ unit="USD",
+ currency="USD",
+ ),
+ main_image="https://rocketamp-sample-store.myshopify.com/cdn/shop/products/Gildan_2000_Antique_Cherry_Red_Front_1024x1024.jpg?v=1527232987",
+ ),
+ ),
)
```
@@ -5188,7 +5593,7 @@ client.orders.update_fulfill(
-
-**order_id:** `str` — Unique identifier for an Order
+**product:** `ProductSkuCreateProduct`
@@ -5196,7 +5601,15 @@ client.orders.update_fulfill(
-
-**send_order_fulfilled_email:** `typing.Optional[bool]` — Whether or not the Order Fulfilled email should be sent
+**sku:** `ProductSkuCreateSku`
+
+
+
+
+
+-
+
+**publish_status:** `typing.Optional[PublishStatus]`
@@ -5216,7 +5629,7 @@ client.orders.update_fulfill(
client.orders.update_unfulfill(...) -> Order
+client.products.get(...) -> ProductAndSkUs
-
@@ -5228,9 +5641,10 @@ client.orders.update_fulfill(
-
-Updates an order's status to unfulfilled
+Retrieve a single product by its ID. All of its SKUs will also be
+retrieved.
-Required scope | `ecommerce:write`
+Required scope | `ecommerce:read`
@@ -5253,9 +5667,9 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.orders.update_unfulfill(
+client.products.get(
site_id="580e63e98c9a982ac9b8b741",
- order_id="5e8518516e147040726cc415",
+ product_id="580e63fc8c9a982ac9b8b745",
)
```
@@ -5280,7 +5694,7 @@ client.orders.update_unfulfill(
-
-**order_id:** `str` — Unique identifier for an Order
+**product_id:** `str` — Unique identifier for a Product
@@ -5300,7 +5714,7 @@ client.orders.update_unfulfill(
client.orders.refund(...) -> Order
+client.products.update(...) -> Product
-
@@ -5312,8 +5726,9 @@ client.orders.update_unfulfill(
-
-This API will reverse a Stripe charge and refund an order back to a
-customer. It will also set the order's status to `refunded`.
+Update an existing Product.
+
+Updating an existing Product will set the product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.
Required scope | `ecommerce:write`
@@ -5338,9 +5753,9 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.orders.refund(
+client.products.update(
site_id="580e63e98c9a982ac9b8b741",
- order_id="5e8518516e147040726cc415",
+ product_id="580e63fc8c9a982ac9b8b745",
)
```
@@ -5365,7 +5780,7 @@ client.orders.refund(
-
-**order_id:** `str` — Unique identifier for an Order
+**product_id:** `str` — Unique identifier for a Product
@@ -5373,7 +5788,23 @@ client.orders.refund(
-
-**reason:** `typing.Optional[OrdersRefundRequestReason]` — The reason for the refund
+**publish_status:** `typing.Optional[PublishStatus]`
+
+
+
+
+
+-
+
+**product:** `typing.Optional[Product]`
+
+
+
+
+
+-
+
+**sku:** `typing.Optional[Sku]`
@@ -5393,8 +5824,7 @@ client.orders.refund(
client.inventory.list(...) -> InventoryItem
+client.products.create_sku(...) -> ProductsCreateSkuResponse
-
@@ -5406,9 +5836,11 @@ client.orders.refund(
-
-List the current inventory levels for a particular SKU item.
+Create additional SKUs to manage every [option and variant of your Product.](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants)
-Required scope | `ecommerce:read`
+Creating SKUs through the API will set the product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.
+
+Required scope | `ecommerce:write`
@@ -5423,17 +5855,36 @@ Required scope | `ecommerce:read`
-
```python
-from webflow import Webflow
+from webflow import Webflow, Sku, SkuFieldData, SkuFieldDataPrice
from webflow.environment import WebflowEnvironment
+import datetime
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.inventory.list(
- sku_collection_id="6377a7c4b7a79608c34a46f7",
- sku_id="5e8518516e147040726cc415",
+client.products.create_sku(
+ site_id="580e63e98c9a982ac9b8b741",
+ product_id="580e63fc8c9a982ac9b8b745",
+ skus=[
+ Sku(
+ id="66072fb71b89448912e2681c",
+ cms_locale_id="653ad57de882f528b32e810e",
+ last_published=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"),
+ last_updated=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"),
+ created_on=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"),
+ field_data=SkuFieldData(
+ name="Colorful T-shirt - Default",
+ slug="colorful-t-shirt-default",
+ price=SkuFieldDataPrice(
+ value=2499,
+ unit="USD",
+ currency="USD",
+ ),
+ ),
+ )
+ ],
)
```
@@ -5450,7 +5901,7 @@ client.inventory.list(
-
-**sku_collection_id:** `str` — Unique identifier for a SKU collection. Use the List Collections API to find this ID.
+**site_id:** `str` — Unique identifier for a Site
@@ -5458,7 +5909,23 @@ client.inventory.list(
-
-**sku_id:** `str` — Unique identifier for a SKU
+**product_id:** `str` — Unique identifier for a Product
+
+
+
+
+
+-
+
+**skus:** `typing.List[Sku]` — An array of the SKU data your are adding
+
+
+
+
+
+-
+
+**publish_status:** `typing.Optional[PublishStatus]`
@@ -5478,7 +5945,7 @@ client.inventory.list(
client.inventory.update(...) -> InventoryItem
+client.products.update_sku(...) -> Sku
-
@@ -5490,11 +5957,9 @@ client.inventory.list(
-
-Updates the current inventory levels for a particular SKU item.
+Update a specified SKU.
-Updates may be given in one or two methods, absolutely or incrementally.
-- Absolute updates are done by setting `quantity` directly.
-- Incremental updates are by specifying the inventory delta in `updateQuantity` which is then added to the `quantity` stored on the server.
+Updating an existing SKU will set the Product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.
Required scope | `ecommerce:write`
@@ -5511,18 +5976,35 @@ Required scope | `ecommerce:write`
-
```python
-from webflow import Webflow
+from webflow import Webflow, Sku, SkuFieldData, SkuFieldDataPrice
from webflow.environment import WebflowEnvironment
+import datetime
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.inventory.update(
- sku_collection_id="6377a7c4b7a79608c34a46f7",
- sku_id="5e8518516e147040726cc415",
- inventory_type="infinite",
+client.products.update_sku(
+ site_id="580e63e98c9a982ac9b8b741",
+ product_id="580e63fc8c9a982ac9b8b745",
+ sku_id="5e8518516e147040726cc415",
+ sku=Sku(
+ id="66072fb71b89448912e2681c",
+ cms_locale_id="653ad57de882f528b32e810e",
+ last_published=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"),
+ last_updated=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"),
+ created_on=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"),
+ field_data=SkuFieldData(
+ name="Colorful T-shirt - Default",
+ slug="colorful-t-shirt-default",
+ price=SkuFieldDataPrice(
+ value=2499,
+ unit="USD",
+ currency="USD",
+ ),
+ ),
+ ),
)
```
@@ -5539,7 +6021,7 @@ client.inventory.update(
-
-**sku_collection_id:** `str` — Unique identifier for a SKU collection. Use the List Collections API to find this ID.
+**site_id:** `str` — Unique identifier for a Site
@@ -5547,7 +6029,7 @@ client.inventory.update(
-
-**sku_id:** `str` — Unique identifier for a SKU
+**product_id:** `str` — Unique identifier for a Product
@@ -5555,7 +6037,7 @@ client.inventory.update(
-
-**inventory_type:** `InventoryUpdateRequestInventoryType` — infinite or finite
+**sku_id:** `str` — Unique identifier for a SKU
@@ -5563,7 +6045,7 @@ client.inventory.update(
-
-**update_quantity:** `typing.Optional[float]` — Adds this quantity to currently store quantity. Can be negative.
+**sku:** `Sku`
@@ -5571,7 +6053,7 @@ client.inventory.update(
-
-**quantity:** `typing.Optional[float]` — Immediately sets quantity to this value.
+**publish_status:** `typing.Optional[PublishStatus]`
@@ -5591,8 +6073,8 @@ client.inventory.update(
client.ecommerce.get_settings(...) -> EcommerceSettings
+## Orders
+client.orders.list(...) -> OrderList
-
@@ -5604,7 +6086,7 @@ client.inventory.update(
-
-Retrieve ecommerce settings for a site.
+List all orders created for a given site.
Required scope | `ecommerce:read`
@@ -5629,8 +6111,11 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.ecommerce.get_settings(
+client.orders.list(
site_id="580e63e98c9a982ac9b8b741",
+ status="pending",
+ offset=1,
+ limit=1,
)
```
@@ -5655,6 +6140,30 @@ client.ecommerce.get_settings(
-
+**status:** `typing.Optional[OrdersListRequestStatus]` — Filter the orders by status
+
+
+
+
+
+-
+
+**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
+
+
+
+
+
+-
+
+**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -5667,8 +6176,7 @@ client.ecommerce.get_settings(
client.collections.fields.create(...) -> FieldCreate
+client.orders.get(...) -> Order
-
@@ -5680,13 +6188,10 @@ client.ecommerce.get_settings(
-
-Create a custom field in a collection.
-
-Field validation is currently not available through the API.
-
-Bulk creation of fields is not supported with this endpoint. To add multiple fields at once, include them when you [create the collection.](/data/v2.0.0/reference/cms/collections/create)
+Retrieve a single product by its ID. All of its SKUs will also be
+retrieved.
-Required scope | `cms:write`
+Required scope | `ecommerce:read`
@@ -5701,7 +6206,7 @@ Required scope | `cms:write`
-
```python
-from webflow import Webflow, StaticField
+from webflow import Webflow
from webflow.environment import WebflowEnvironment
client = Webflow(
@@ -5709,16 +6214,9 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.collections.fields.create(
- collection_id="580e63fc8c9a982ac9b8b745",
- request=StaticField(
- id="562ac0395358780a1f5e6fbc",
- is_editable=True,
- is_required=False,
- type="RichText",
- display_name="Post Body",
- help_text="Add the body of your post here",
- ),
+client.orders.get(
+ site_id="580e63e98c9a982ac9b8b741",
+ order_id="5e8518516e147040726cc415",
)
```
@@ -5735,7 +6233,7 @@ client.collections.fields.create(
-
-**collection_id:** `str` — Unique identifier for a Collection
+**site_id:** `str` — Unique identifier for a Site
@@ -5743,7 +6241,7 @@ client.collections.fields.create(
-
-**request:** `FieldCreate`
+**order_id:** `str` — Unique identifier for an Order
@@ -5763,7 +6261,7 @@ client.collections.fields.create(
client.collections.fields.delete(...)
+client.orders.update(...) -> Order
-
@@ -5775,9 +6273,11 @@ client.collections.fields.create(
-
-Delete a custom field in a collection. This endpoint does not currently support bulk deletion.
+This API lets you update the fields, `comment`, `shippingProvider`,
+and/or `shippingTracking` for a given order. All three fields can be
+updated simultaneously or independently.
-Required scope | `cms:write`
+Required scope | `ecommerce:write`
@@ -5800,9 +6300,9 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.collections.fields.delete(
- collection_id="580e63fc8c9a982ac9b8b745",
- field_id="580e63fc8c9a982ac9b8b745",
+client.orders.update(
+ site_id="580e63e98c9a982ac9b8b741",
+ order_id="5e8518516e147040726cc415",
)
```
@@ -5819,7 +6319,7 @@ client.collections.fields.delete(
-
-**collection_id:** `str` — Unique identifier for a Collection
+**site_id:** `str` — Unique identifier for a Site
@@ -5827,7 +6327,39 @@ client.collections.fields.delete(
-
-**field_id:** `str` — Unique identifier for a Field in a collection
+**order_id:** `str` — Unique identifier for an Order
+
+
+
+
+
+-
+
+**comment:** `typing.Optional[str]` — Arbitrary data for your records
+
+
+
+
+
+-
+
+**shipping_provider:** `typing.Optional[str]` — Company or method used to ship order
+
+
+
+
+
+-
+
+**shipping_tracking:** `typing.Optional[str]` — Tracking number for order shipment
+
+
+
+
+
+-
+
+**shipping_tracking_url:** `typing.Optional[str]` — URL to track order shipment
@@ -5847,7 +6379,7 @@ client.collections.fields.delete(
client.collections.fields.update(...) -> Field
+client.orders.update_fulfill(...) -> Order
-
@@ -5859,9 +6391,9 @@ client.collections.fields.delete(
-
-Update a custom field in a collection.
+Updates an order's status to fulfilled
-Required scope | `cms:write`
+Required scope | `ecommerce:write`
@@ -5884,12 +6416,9 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.collections.fields.update(
- collection_id="580e63fc8c9a982ac9b8b745",
- field_id="580e63fc8c9a982ac9b8b745",
- is_required=False,
- display_name="Post Body",
- help_text="Add the body of your post here",
+client.orders.update_fulfill(
+ site_id="580e63e98c9a982ac9b8b741",
+ order_id="5e8518516e147040726cc415",
)
```
@@ -5906,23 +6435,7 @@ client.collections.fields.update(
-
-**collection_id:** `str` — Unique identifier for a Collection
-
-
-
-
-
--
-
-**field_id:** `str` — Unique identifier for a Field in a collection
-
-
-
-
-
--
-
-**is_required:** `typing.Optional[bool]` — Define whether a field is required in a collection
+**site_id:** `str` — Unique identifier for a Site
@@ -5930,7 +6443,7 @@ client.collections.fields.update(
-
-**display_name:** `typing.Optional[str]` — The name of a field
+**order_id:** `str` — Unique identifier for an Order
@@ -5938,7 +6451,7 @@ client.collections.fields.update(
-
-**help_text:** `typing.Optional[str]` — Additional text to help anyone filling out this field
+**send_order_fulfilled_email:** `typing.Optional[bool]` — Whether or not the Order Fulfilled email should be sent
@@ -5958,8 +6471,7 @@ client.collections.fields.update(
client.collections.items.list_items(...) -> CollectionItemList
+client.orders.update_unfulfill(...) -> Order
-
@@ -5971,9 +6483,9 @@ client.collections.fields.update(
-
-List of all Items within a Collection.
+Updates an order's status to unfulfilled
-Required scope | `CMS:read`
+Required scope | `ecommerce:write`
@@ -5996,15 +6508,9 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.collections.items.list_items(
- collection_id="580e63fc8c9a982ac9b8b745",
- cms_locale_id="cmsLocaleId",
- offset=1,
- limit=1,
- name="name",
- slug="slug",
- sort_by="lastPublished",
- sort_order="asc",
+client.orders.update_unfulfill(
+ site_id="580e63e98c9a982ac9b8b741",
+ order_id="5e8518516e147040726cc415",
)
```
@@ -6021,15 +6527,7 @@ client.collections.items.list_items(
-
-**collection_id:** `str` — Unique identifier for a Collection
-
-
-
-
-
--
-
-**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
+**site_id:** `str` — Unique identifier for a Site
@@ -6037,7 +6535,7 @@ client.collections.items.list_items(
-
-**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
+**order_id:** `str` — Unique identifier for an Order
@@ -6045,67 +6543,7116 @@ client.collections.items.list_items(
-
-**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
--
-
-**name:** `typing.Optional[str]` — Filter by the exact name of the item(s)
-
-
--
-**slug:** `typing.Optional[str]` — Filter by the exact slug of the item
-
+
client.orders.refund(...) -> Order
-
-**last_published:** `typing.Optional[ItemsListItemsRequestLastPublished]` — Filter by the last published date of the item(s)
-
-
-
+#### 📝 Description
-
-**sort_by:** `typing.Optional[ItemsListItemsRequestSortBy]` — Sort results by the provided value
-
-
-
-
-
-**sort_order:** `typing.Optional[ItemsListItemsRequestSortOrder]` — Sorts the results by asc or desc
-
-
-
-
-
--
+This API will reverse a Stripe charge and refund an order back to a
+customer. It will also set the order's status to `refunded`.
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
+Required scope | `ecommerce:write`
+#### 🔌 Usage
-
-
-client.collections.items.create_item(...) -> CollectionItem
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.orders.refund(
+ site_id="580e63e98c9a982ac9b8b741",
+ order_id="5e8518516e147040726cc415",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**order_id:** `str` — Unique identifier for an Order
+
+
+
+
+
+-
+
+**reason:** `typing.Optional[OrdersRefundRequestReason]` — The reason for the refund
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.inventory.list(...) -> InventoryItem
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+List the current inventory levels for a particular SKU item.
+
+Required scope | `ecommerce:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.inventory.list(
+ sku_collection_id="6377a7c4b7a79608c34a46f7",
+ sku_id="5e8518516e147040726cc415",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**sku_collection_id:** `str` — Unique identifier for a SKU collection. Use the List Collections API to find this ID.
+
+
+
+
+
+-
+
+**sku_id:** `str` — Unique identifier for a SKU
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.inventory.update(...) -> InventoryItem
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates the current inventory levels for a particular SKU item.
+
+Updates may be given in one or two methods, absolutely or incrementally.
+- Absolute updates are done by setting `quantity` directly.
+- Incremental updates are by specifying the inventory delta in `updateQuantity` which is then added to the `quantity` stored on the server.
+
+Required scope | `ecommerce:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.inventory.update(
+ sku_collection_id="6377a7c4b7a79608c34a46f7",
+ sku_id="5e8518516e147040726cc415",
+ inventory_type="infinite",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**sku_collection_id:** `str` — Unique identifier for a SKU collection. Use the List Collections API to find this ID.
+
+
+
+
+
+-
+
+**sku_id:** `str` — Unique identifier for a SKU
+
+
+
+
+
+-
+
+**inventory_type:** `InventoryUpdateRequestInventoryType` — infinite or finite
+
+
+
+
+
+-
+
+**update_quantity:** `typing.Optional[float]` — Adds this quantity to currently store quantity. Can be negative.
+
+
+
+
+
+-
+
+**quantity:** `typing.Optional[float]` — Immediately sets quantity to this value.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ecommerce.get_settings(...) -> EcommerceSettings
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieve ecommerce settings for a site.
+
+Required scope | `ecommerce:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.ecommerce.get_settings(
+ site_id="580e63e98c9a982ac9b8b741",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.analyze.reports.traffic(...) -> TrafficResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a daily time series of a single metric — sessions, users, or page views — over a time window.
+
+Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+This endpoint requires a workspace with the Analyze add-on.
+
+Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+import datetime
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.analyze.reports.traffic(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat("2026-04-01T00:00:00+00:00"),
+ end_time=datetime.datetime.fromisoformat("2026-04-08T00:00:00+00:00"),
+ metric_scope="session",
+ bucket_time_zone="America/New_York",
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**start_time:** `datetime.datetime` — Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+
+
+
+
+-
+
+**end_time:** `datetime.datetime` — Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+
+
+
+
+-
+
+**metric_scope:** `TrafficMetricScope` — The unit each `count` data point is measured in.
+
+
+
+
+
+-
+
+**bucket_time_zone:** `AnalyzeBucketTimeZone` — IANA time zone used to align daily bucket boundaries.
+
+
+
+
+
+-
+
+**device_type:** `typing.Optional[ReportsTrafficRequestDeviceType]` — Restrict the report to a single device type.
+
+
+
+
+
+-
+
+**country:** `typing.Optional[str]` — Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+
+
+
+
+-
+
+**page_path:** `typing.Optional[str]` — Restrict the report to a single page path.
+
+
+
+
+
+-
+
+**traffic_source:** `typing.Optional[str]` — Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+
+
+
+
+-
+
+**referrer:** `typing.Optional[str]` — Restrict the report to a single referrer domain.
+
+
+
+
+
+-
+
+**browser:** `typing.Optional[str]` — Restrict the report to a single browser.
+
+
+
+
+
+-
+
+**utm_campaign:** `typing.Optional[str]` — Restrict the report to a single `utm_campaign` value.
+
+
+
+
+
+-
+
+**utm_medium:** `typing.Optional[str]` — Restrict the report to a single `utm_medium` value.
+
+
+
+
+
+-
+
+**utm_source:** `typing.Optional[str]` — Restrict the report to a single `utm_source` value.
+
+
+
+
+
+-
+
+**filter:** `typing.Optional[TrafficFilter]`
+
+Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TrafficFilter` schema for the full list of supported dimensions.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.analyze.reports.top_pages(...) -> TopPagesResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the most-visited pages over a time window, ranked by `sortBy` (sessions, users, or page views).
+
+Each row carries all three scope counts; `sortBy` only governs ordering. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+Set `timeseries[bucketTimeZone]` to attach a daily page view `timeseries` to each row. Bucket counts are always page views regardless of `sortBy`. Row-level counts honor the requested sort, but the timeseries does not.
+
+This endpoint requires a workspace with the Analyze add-on.
+
+Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+import datetime
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.analyze.reports.top_pages(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat("2026-04-01T00:00:00+00:00"),
+ end_time=datetime.datetime.fromisoformat("2026-04-08T00:00:00+00:00"),
+ sort_by="session",
+ limit=1,
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**start_time:** `datetime.datetime` — Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+
+
+
+
+-
+
+**end_time:** `datetime.datetime` — Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+
+
+
+
+-
+
+**sort_by:** `typing.Optional[TopPagesSortBy]` — Metric used to rank rows in the response, descending. Defaults to `session`.
+
+
+
+
+
+-
+
+**limit:** `typing.Optional[int]` — Maximum number of rows to return. Defaults to `25`, up to a maximum of `250`.
+
+
+
+
+
+-
+
+**timeseries:** `typing.Optional[AnalyzeDailyTimeseriesQuery]` — Include a daily page view `timeseries` for each row, bucketed in the supplied IANA time zone. Omit this parameter to return ranked rows without per-page timeseries data.
+
+
+
+
+
+-
+
+**device_type:** `typing.Optional[ReportsTopPagesRequestDeviceType]` — Restrict the report to a single device type.
+
+
+
+
+
+-
+
+**country:** `typing.Optional[str]` — Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+
+
+
+
+-
+
+**page_path:** `typing.Optional[str]` — Restrict the report to a single page path.
+
+
+
+
+
+-
+
+**traffic_source:** `typing.Optional[str]` — Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+
+
+
+
+-
+
+**referrer:** `typing.Optional[str]` — Restrict the report to a single referrer domain.
+
+
+
+
+
+-
+
+**browser:** `typing.Optional[str]` — Restrict the report to a single browser.
+
+
+
+
+
+-
+
+**utm_campaign:** `typing.Optional[str]` — Restrict the report to a single `utm_campaign` value.
+
+
+
+
+
+-
+
+**utm_medium:** `typing.Optional[str]` — Restrict the report to a single `utm_medium` value.
+
+
+
+
+
+-
+
+**utm_source:** `typing.Optional[str]` — Restrict the report to a single `utm_source` value.
+
+
+
+
+
+-
+
+**filter:** `typing.Optional[TopPagesFilter]`
+
+Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TopPagesFilter` schema for the full list of supported dimensions.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.analyze.reports.top_dimensions(...) -> TopDimensionsResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the top values within a chosen `dimension` — top countries, top traffic sources, top campaigns, top audiences, and so on — over a time window, ranked by sessions or users.
+
+Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+This endpoint requires a workspace with the Analyze add-on.
+
+Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+import datetime
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.analyze.reports.top_dimensions(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat("2026-04-01T00:00:00+00:00"),
+ end_time=datetime.datetime.fromisoformat("2026-04-08T00:00:00+00:00"),
+ dimension="country",
+ metric_scope="session",
+ limit=1,
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**start_time:** `datetime.datetime` — Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+
+
+
+
+-
+
+**end_time:** `datetime.datetime` — Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+
+
+
+
+-
+
+**dimension:** `TopDimensionsDimension` — The dimension whose top values are ranked. See `TopDimensionsDimension` for the supported values.
+
+
+
+
+
+-
+
+**metric_scope:** `TopDimensionsMetricScope` — The unit each row's `count` is measured in — sessions or users.
+
+
+
+
+
+-
+
+**limit:** `typing.Optional[int]` — Maximum number of rows to return. Defaults to `25`, up to a maximum of `100`.
+
+
+
+
+
+-
+
+**device_type:** `typing.Optional[ReportsTopDimensionsRequestDeviceType]` — Restrict the report to a single device type.
+
+
+
+
+
+-
+
+**country:** `typing.Optional[str]` — Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+
+
+
+
+-
+
+**page_path:** `typing.Optional[str]` — Restrict the report to a single page path.
+
+
+
+
+
+-
+
+**traffic_source:** `typing.Optional[str]` — Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+
+
+
+
+-
+
+**referrer:** `typing.Optional[str]` — Restrict the report to a single referrer domain.
+
+
+
+
+
+-
+
+**browser:** `typing.Optional[str]` — Restrict the report to a single browser.
+
+
+
+
+
+-
+
+**utm_campaign:** `typing.Optional[str]` — Restrict the report to a single `utm_campaign` value.
+
+
+
+
+
+-
+
+**utm_medium:** `typing.Optional[str]` — Restrict the report to a single `utm_medium` value.
+
+
+
+
+
+-
+
+**utm_source:** `typing.Optional[str]` — Restrict the report to a single `utm_source` value.
+
+
+
+
+
+-
+
+**filter:** `typing.Optional[TopDimensionsFilter]`
+
+Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TopDimensionsFilter` schema for the full list of supported dimensions.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.analyze.reports.top_events(...) -> TopEventsResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the top events over a time window, ranked by how often they occurred.
+
+Events are counted individually, not rolled up into sessions, users, or page views — so this report has no `metricScope`. Each row's `count` is how many times the event occurred. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+Set `timeseries[bucketTimeZone]` to attach a daily event count `timeseries` to each row.
+
+This endpoint requires a workspace with the Analyze add-on.
+
+Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+import datetime
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.analyze.reports.top_events(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat("2026-04-01T00:00:00+00:00"),
+ end_time=datetime.datetime.fromisoformat("2026-04-08T00:00:00+00:00"),
+ limit=1,
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**start_time:** `datetime.datetime` — Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+
+
+
+
+-
+
+**end_time:** `datetime.datetime` — Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+
+
+
+
+-
+
+**limit:** `typing.Optional[int]` — Maximum number of rows to return. Defaults to `25`, up to a maximum of `250`.
+
+
+
+
+
+-
+
+**timeseries:** `typing.Optional[AnalyzeDailyTimeseriesQuery]` — Include a daily event count `timeseries` for each row, bucketed in the supplied IANA time zone. Omit this parameter to return ranked rows without per-event timeseries data.
+
+
+
+
+
+-
+
+**device_type:** `typing.Optional[ReportsTopEventsRequestDeviceType]` — Restrict the report to a single device type.
+
+
+
+
+
+-
+
+**country:** `typing.Optional[str]` — Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+
+
+
+
+-
+
+**page_path:** `typing.Optional[str]` — Restrict the report to a single page path.
+
+
+
+
+
+-
+
+**traffic_source:** `typing.Optional[str]` — Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+
+
+
+
+-
+
+**browser:** `typing.Optional[str]` — Restrict the report to a single browser.
+
+
+
+
+
+-
+
+**utm_campaign:** `typing.Optional[str]` — Restrict the report to a single `utm_campaign` value.
+
+
+
+
+
+-
+
+**utm_medium:** `typing.Optional[str]` — Restrict the report to a single `utm_medium` value.
+
+
+
+
+
+-
+
+**utm_source:** `typing.Optional[str]` — Restrict the report to a single `utm_source` value.
+
+
+
+
+
+-
+
+**filter:** `typing.Optional[TopEventsFilter]`
+
+Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TopEventsFilter` schema for the full list of supported dimensions.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.analyze.reports.time_on_page(...) -> TimeOnPageResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the average time on page over a time window — as a single aggregate value, or bucketed by day or week when `timeseries` is supplied.
+
+Choose how the average is computed with `metricScope` (per session, user, or page view). Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+This endpoint requires a workspace with the Analyze add-on.
+
+Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+import datetime
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.analyze.reports.time_on_page(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat("2026-04-01T00:00:00+00:00"),
+ end_time=datetime.datetime.fromisoformat("2026-04-08T00:00:00+00:00"),
+ metric_scope="session",
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**start_time:** `datetime.datetime` — Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+
+
+
+
+-
+
+**end_time:** `datetime.datetime` — Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+
+
+
+
+-
+
+**metric_scope:** `TimeOnPageMetricScope` — How the average time on page is computed — per session, user, or page view.
+
+
+
+
+
+-
+
+**timeseries:** `typing.Optional[TimeOnPageTimeseriesQuery]` — Include bucketed average time data using the supplied granularity and IANA time zone. Omit this parameter to return a single aggregate value for the requested window.
+
+
+
+
+
+-
+
+**device_type:** `typing.Optional[ReportsTimeOnPageRequestDeviceType]` — Restrict the report to a single device type.
+
+
+
+
+
+-
+
+**country:** `typing.Optional[str]` — Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+
+
+
+
+-
+
+**page_path:** `typing.Optional[str]` — Restrict the report to a single page path.
+
+
+
+
+
+-
+
+**traffic_source:** `typing.Optional[str]` — Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+
+
+
+
+-
+
+**referrer:** `typing.Optional[str]` — Restrict the report to a single referrer domain.
+
+
+
+
+
+-
+
+**browser:** `typing.Optional[str]` — Restrict the report to a single browser.
+
+
+
+
+
+-
+
+**utm_campaign:** `typing.Optional[str]` — Restrict the report to a single `utm_campaign` value.
+
+
+
+
+
+-
+
+**utm_medium:** `typing.Optional[str]` — Restrict the report to a single `utm_medium` value.
+
+
+
+
+
+-
+
+**utm_source:** `typing.Optional[str]` — Restrict the report to a single `utm_source` value.
+
+
+
+
+
+-
+
+**filter:** `typing.Optional[TimeOnPageFilter]`
+
+Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TimeOnPageFilter` schema for the full list of supported dimensions.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.analyze.reports.scroll_depth(...) -> ScrollDepthResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the scroll-depth distribution for the site over a time window. Each row reports the scroll depth (in pixels) that a share of page views reached, at fixed breakpoints of 75%, 50%, and 25% of page views.
+
+Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching. Omit `deviceType` to include all devices.
+
+This endpoint requires a workspace with the Analyze add-on.
+
+Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+import datetime
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.analyze.reports.scroll_depth(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat("2026-04-01T00:00:00+00:00"),
+ end_time=datetime.datetime.fromisoformat("2026-04-08T00:00:00+00:00"),
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**start_time:** `datetime.datetime` — Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+
+
+
+
+-
+
+**end_time:** `datetime.datetime` — Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+
+
+
+
+-
+
+**device_type:** `typing.Optional[ReportsScrollDepthRequestDeviceType]` — Restrict the report to a single device type.
+
+
+
+
+
+-
+
+**country:** `typing.Optional[str]` — Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+
+
+
+
+-
+
+**page_path:** `typing.Optional[str]` — Restrict the report to a single page path.
+
+
+
+
+
+-
+
+**traffic_source:** `typing.Optional[str]` — Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+
+
+
+
+-
+
+**referrer:** `typing.Optional[str]` — Restrict the report to a single referrer domain.
+
+
+
+
+
+-
+
+**browser:** `typing.Optional[str]` — Restrict the report to a single browser.
+
+
+
+
+
+-
+
+**utm_campaign:** `typing.Optional[str]` — Restrict the report to a single `utm_campaign` value.
+
+
+
+
+
+-
+
+**utm_medium:** `typing.Optional[str]` — Restrict the report to a single `utm_medium` value.
+
+
+
+
+
+-
+
+**utm_source:** `typing.Optional[str]` — Restrict the report to a single `utm_source` value.
+
+
+
+
+
+-
+
+**filter:** `typing.Optional[ScrollDepthFilter]`
+
+Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `ScrollDepthFilter` schema for the full list of supported dimensions.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.analyze.reports.browser_window_height(...) -> BrowserWindowHeightResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the average browser window height (in CSS pixels) for the site over a time window. The response wraps the single aggregate in a one-element `data` array for SDK uniformity with other Analyze reports.
+
+Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching. Omit `deviceType` to include all devices.
+
+This endpoint requires a workspace with the Analyze add-on.
+
+Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+import datetime
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.analyze.reports.browser_window_height(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat("2026-04-01T00:00:00+00:00"),
+ end_time=datetime.datetime.fromisoformat("2026-04-08T00:00:00+00:00"),
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**start_time:** `datetime.datetime` — Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+
+
+
+
+-
+
+**end_time:** `datetime.datetime` — Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+
+
+
+
+-
+
+**device_type:** `typing.Optional[ReportsBrowserWindowHeightRequestDeviceType]` — Restrict the report to a single device type.
+
+
+
+
+
+-
+
+**country:** `typing.Optional[str]` — Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+
+
+
+
+-
+
+**page_path:** `typing.Optional[str]` — Restrict the report to a single page path.
+
+
+
+
+
+-
+
+**traffic_source:** `typing.Optional[str]` — Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+
+
+
+
+-
+
+**referrer:** `typing.Optional[str]` — Restrict the report to a single referrer domain.
+
+
+
+
+
+-
+
+**browser:** `typing.Optional[str]` — Restrict the report to a single browser.
+
+
+
+
+
+-
+
+**utm_campaign:** `typing.Optional[str]` — Restrict the report to a single `utm_campaign` value.
+
+
+
+
+
+-
+
+**utm_medium:** `typing.Optional[str]` — Restrict the report to a single `utm_medium` value.
+
+
+
+
+
+-
+
+**utm_source:** `typing.Optional[str]` — Restrict the report to a single `utm_source` value.
+
+
+
+
+
+-
+
+**filter:** `typing.Optional[BrowserWindowHeightFilter]`
+
+Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `BrowserWindowHeightFilter` schema for the full list of supported dimensions.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.analyze.reports.page_flow(...) -> PageFlowResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the pages visitors viewed immediately before or after a required anchor page over a time window, ranked by sessions, users, or page views.
+
+For a CMS template instance, provide both `collectionId` and `itemSlug` with `pageId`. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+This endpoint requires a workspace with the Analyze add-on.
+
+Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+import datetime
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.analyze.reports.page_flow(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat("2026-04-01T00:00:00+00:00"),
+ end_time=datetime.datetime.fromisoformat("2026-04-08T00:00:00+00:00"),
+ direction="previous",
+ metric_scope="session",
+ page_id="65f1b2c4a8d3e5f7a9c1b2d3",
+ collection_id="66abc1234567890abcdef012",
+ item_slug="anchor-post",
+ limit=1,
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**start_time:** `datetime.datetime` — Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+
+
+
+
+-
+
+**end_time:** `datetime.datetime` — Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+
+
+
+
+-
+
+**direction:** `PageFlowDirection` — Whether to return pages viewed immediately before or after the anchor page.
+
+
+
+
+
+-
+
+**metric_scope:** `PageFlowMetricScope` — The unit each row's `count` is measured in.
+
+
+
+
+
+-
+
+**page_id:** `str` — Identifier of the anchor Webflow page.
+
+
+
+
+
+-
+
+**collection_id:** `typing.Optional[str]` — Identifier of the CMS collection for an anchor template-page instance. Must be provided together with `itemSlug`, or both must be omitted.
+
+
+
+
+
+-
+
+**item_slug:** `typing.Optional[str]` — Slug of the CMS item for an anchor template-page instance. Must be provided together with `collectionId`, or both must be omitted.
+
+
+
+
+
+-
+
+**limit:** `typing.Optional[int]` — Maximum number of rows to return. Defaults to `10`, up to a maximum of `100`.
+
+
+
+
+
+-
+
+**device_type:** `typing.Optional[ReportsPageFlowRequestDeviceType]` — Restrict the report to a single device type.
+
+
+
+
+
+-
+
+**country:** `typing.Optional[str]` — Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+
+
+
+
+-
+
+**page_path:** `typing.Optional[str]` — Restrict the report to a single page path.
+
+
+
+
+
+-
+
+**traffic_source:** `typing.Optional[str]` — Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+
+
+
+
+-
+
+**referrer:** `typing.Optional[str]` — Restrict the report to a single referrer domain.
+
+
+
+
+
+-
+
+**browser:** `typing.Optional[str]` — Restrict the report to a single browser.
+
+
+
+
+
+-
+
+**utm_campaign:** `typing.Optional[str]` — Restrict the report to a single `utm_campaign` value.
+
+
+
+
+
+-
+
+**utm_medium:** `typing.Optional[str]` — Restrict the report to a single `utm_medium` value.
+
+
+
+
+
+-
+
+**utm_source:** `typing.Optional[str]` — Restrict the report to a single `utm_source` value.
+
+
+
+
+
+-
+
+**filter:** `typing.Optional[PageFlowFilter]`
+
+Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `PageFlowFilter` schema for the full list of supported dimensions.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.analyze.goals.list_goals(...) -> GoalsResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the goals configured for a site. This endpoint returns a list of goals, not a report. It takes no time window, filters, or other query parameters, and unknown query parameters return `400 analyze_input_validation`.
+
+Each goal includes its type (`goalType`) and whether it's a site goal (`isSiteGoal`). Integration goals also include `integrationSource`, and HubSpot or Marketo form goals include the `formId`. Use a goal's `goalId` with [Get Goal Performance](/data/reference/analyze/goal-performance) to get its daily conversions.
+
+This endpoint requires a workspace with the Analyze add-on.
+
+Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.analyze.goals.list_goals(
+ site_id="580e63e98c9a982ac9b8b741",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.analyze.goals.goal_performance(...) -> GoalPerformanceResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns daily conversion counts for one goal over a time window, together with the goal's configuration (the same object [List Goals](/data/reference/analyze/list-goals) returns). Conversions are always counted as unique conversions.
+
+Days are bucketed in `bucketTimeZone`, which defaults to `UTC`. An unknown `goal_id` returns `404`. A goal with no conversions in the window returns an empty `data` array. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+This endpoint requires a workspace with the Analyze add-on.
+
+Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+import datetime
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.analyze.goals.goal_performance(
+ site_id="580e63e98c9a982ac9b8b741",
+ goal_id="198020177",
+ start_time=datetime.datetime.fromisoformat("2026-04-01T00:00:00+00:00"),
+ end_time=datetime.datetime.fromisoformat("2026-04-08T00:00:00+00:00"),
+ bucket_time_zone="America/New_York",
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**goal_id:** `str` — Identifier of the goal, from `goalId` in [List Goals](/data/reference/analyze/list-goals). A numeric string, not a Webflow object ID.
+
+
+
+
+
+-
+
+**start_time:** `datetime.datetime` — Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+
+
+
+
+-
+
+**end_time:** `datetime.datetime` — Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+
+
+
+
+-
+
+**bucket_time_zone:** `typing.Optional[AnalyzeBucketTimeZone]` — IANA time zone used to align daily bucket boundaries. Defaults to `UTC`.
+
+
+
+
+
+-
+
+**device_type:** `typing.Optional[GoalsGoalPerformanceRequestDeviceType]` — Restrict the report to a single device type.
+
+
+
+
+
+-
+
+**country:** `typing.Optional[str]` — Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+
+
+
+
+-
+
+**page_path:** `typing.Optional[str]` — Restrict the report to a single page path.
+
+
+
+
+
+-
+
+**traffic_source:** `typing.Optional[str]` — Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+
+
+
+
+-
+
+**referrer:** `typing.Optional[str]` — Restrict the report to a single referrer domain.
+
+
+
+
+
+-
+
+**browser:** `typing.Optional[str]` — Restrict the report to a single browser.
+
+
+
+
+
+-
+
+**utm_campaign:** `typing.Optional[str]` — Restrict the report to a single `utm_campaign` value.
+
+
+
+
+
+-
+
+**utm_medium:** `typing.Optional[str]` — Restrict the report to a single `utm_medium` value.
+
+
+
+
+
+-
+
+**utm_source:** `typing.Optional[str]` — Restrict the report to a single `utm_source` value.
+
+
+
+
+
+-
+
+**filter:** `typing.Optional[GoalPerformanceFilter]`
+
+Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `GoalPerformanceFilter` schema for the full list of supported dimensions.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.collections.fields.create(...) -> FieldCreate
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create a custom field in a collection.
+
+Field validation is currently not available through the API.
+
+Bulk creation of fields is not supported with this endpoint. To add multiple fields at once, include them when you [create the collection.](/data/v2.0.0/reference/cms/collections/create)
+
+Required scope | `cms:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow, StaticField
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.collections.fields.create(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ request=StaticField(
+ id="562ac0395358780a1f5e6fbc",
+ is_editable=True,
+ is_required=False,
+ type="RichText",
+ display_name="Post Body",
+ help_text="Add the body of your post here",
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_id:** `str` — Unique identifier for a Collection
+
+
+
+
+
+-
+
+**request:** `FieldCreate`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.collections.fields.delete(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete a custom field in a collection. This endpoint does not currently support bulk deletion.
+
+Required scope | `cms:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.collections.fields.delete(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ field_id="580e63fc8c9a982ac9b8b745",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_id:** `str` — Unique identifier for a Collection
+
+
+
+
+
+-
+
+**field_id:** `str` — Unique identifier for a Field in a collection
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.collections.fields.update(...) -> Field
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Update a custom field in a collection.
+
+Required scope | `cms:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.collections.fields.update(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ field_id="580e63fc8c9a982ac9b8b745",
+ is_required=False,
+ display_name="Post Body",
+ help_text="Add the body of your post here",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_id:** `str` — Unique identifier for a Collection
+
+
+
+
+
+-
+
+**field_id:** `str` — Unique identifier for a Field in a collection
+
+
+
+
+
+-
+
+**is_required:** `typing.Optional[bool]` — Define whether a field is required in a collection
+
+
+
+
+
+-
+
+**display_name:** `typing.Optional[str]` — The name of a field
+
+
+
+
+
+-
+
+**help_text:** `typing.Optional[str]` — Additional text to help anyone filling out this field
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.collections.items.list_items(...) -> CollectionItemList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+
+ Rich Text field values can contain Webflow component instances as `` markup — see [Components in Rich Text](/data/docs/working-with-the-cms/components-in-rich-text) for the markup grammar, how to find component and property IDs, and the write constraints.
+
+
+List of all Items within a Collection.
+
+
+ This endpoint supports:
+
+ - Custom `filter[...]` queries support up to 10 filter terms and 2 text-search terms per request.
+ - Custom `sort[...]` queries support up to 3 sort fields per request.
+
+
+Required scope | `CMS:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.collections.items.list_items(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ cms_locale_id="cmsLocaleId",
+ offset=1,
+ limit=1,
+ name="name",
+ slug="slug",
+ sort_by="createdOn",
+ sort_order="asc",
+ translatable="65427cf400e02b306eaa04a0",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_id:** `str` — Unique identifier for a Collection
+
+
+
+
+
+-
+
+**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
+
+
+
+
+
+-
+
+**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
+
+
+
+
+
+-
+
+**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+
+
+
+
+
+-
+
+**name:** `typing.Optional[str]` — Filter by the exact name of the item(s)
+
+
+
+
+
+-
+
+**slug:** `typing.Optional[str]` — Filter by the exact slug of the item
+
+
+
+
+
+-
+
+**created_on:** `typing.Optional[ItemsListItemsRequestCreatedOn]` — Filter by the creation date of the item(s)
+
+
+
+
+
+-
+
+**last_published:** `typing.Optional[ItemsListItemsRequestLastPublished]` — Filter by the last published date of the item(s)
+
+
+
+
+
+-
+
+**last_updated:** `typing.Optional[ItemsListItemsRequestLastUpdated]` — Filter by the last updated date of the item(s)
+
+
+
+
+
+-
+
+**filter:** `typing.Optional[typing.Dict[str, typing.Optional[ItemsListItemsRequestFilterValue]]]`
+
+Filter collection items by custom field values. Use bracket notation:
+`filter[][]=`.
+
+Example: `filter[price][gte]=10&filter[price][lte]=100&filter[name][contains]=shirt`.
+
+Filters are combined with AND. You can combine custom field filters with top-level filters such as `name`, `slug`, `createdOn`, `lastPublished`, and `lastUpdated`. OR logic and nested filter groups are not supported on GET requests.
+
+More filter terms can increase request latency.
+
+Supported operators by field type:
+
+| Field type | Supported operators |
+| --- | --- |
+| `id` | `eq`, `ne`, `in`, `nin` |
+| `PlainText` | `eq`, `ne`, `in`, `nin`, `contains`, `ncontains`, `exists` |
+| `Number` | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`, `exists` |
+| `Switch` | `eq`, `ne`, `in`, `nin`, `exists` |
+| `DateTime` | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`, `exists` |
+| `Email`, `Phone`, `Link` | `eq`, `ne`, `in`, `nin`, `contains`, `ncontains`, `exists` |
+| `Color` | `eq`, `ne`, `in`, `nin`, `exists` |
+| `Reference` | `eq`, `ne`, `in`, `nin`, `exists` |
+| `Option` | `eq`, `ne`, `in`, `nin` |
+| `RichText`, `Image`, `MultiImage`, `VideoLink`, `MultiReference` | `exists` |
+
+`contains` and `ncontains` are case-insensitive. `ncontains` also matches items where the field is empty or not set.
+
+`exists=true` matches items where the field has a value. `exists=false` matches items where the field is missing or null. For `Switch` fields, `false` is still a set value.
+
+Value formats:
+
+| Field type | Value format |
+| --- | --- |
+| `Number` | A valid number, such as `10` or `12.5` |
+| `Switch` | `true` or `false` |
+| `DateTime` | ISO 8601 date-time string |
+| `id`, `Reference` | 24-character item ID |
+| `Option` | Option ID |
+| `in`, `nin` | Comma-separated list, up to 100 values |
+
+Invalid fields, invalid values, and operators that do not apply to a field type return a `400 BadArgument` response.
+
+
+
+
+
+-
+
+**sort_by:** `typing.Optional[ItemsListItemsRequestSortBy]` — Sort results by the provided value
+
+
+
+
+
+-
+
+**sort_order:** `typing.Optional[ItemsListItemsRequestSortOrder]` — Sorts the results by asc or desc
+
+
+
+
+
+-
+
+**sort:** `typing.Optional[typing.Dict[str, typing.Optional[ItemsListItemsRequestSortValue]]]`
+
+Sort collection items by custom fields using bracket notation: `sort[]=`.
+
+- Example: `sort[price]=desc`
+- Multiple sort fields are applied in query-string order. When `sort[...]` is provided, it takes precedence over `sortBy` and `sortOrder`.
+- Sortable field types: `PlainText`, `Email`, `Phone`, `Number`, `DateTime`, and `Switch`.
+- Unknown fields, invalid sort directions, and non-sortable field types return a `400 BadArgument` response.
+
+
+
+
+
+-
+
+**translatable:** `typing.Optional[str]`
+
+Unique identifier for the secondary Locale you're translating **into**. Returns only content that hasn't been excluded from translation for that locale.
+
+This is independent of `localeId`, which selects which version of the content is returned. To fetch the source text to translate, request the primary locale's content and set `translatable` to the locale you're translating into:
+
+`?localeId={primary locale id}&translatable={target locale id}`
+
+Only exclusion rules scoped to manual translation are respected — rules scoped only to automatic translation don't affect this parameter's response.
+
+Omitting `translatable` returns the same response as if this parameter didn't exist. The value must be the id of one of the site's secondary locales — the primary locale id, or any other value, returns a `400` error. Requires translation exclusions to be enabled for the site; if they aren't, the request returns a `403` error.
+
+[Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.collections.items.create_item(...) -> CollectionItem
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+
+ Rich Text field values can contain Webflow component instances as `` markup — see [Components in Rich Text](/data/docs/working-with-the-cms/components-in-rich-text) for the markup grammar, how to find component and property IDs, and the write constraints.
+
+
+Create Item(s) in a Collection.
+
+
+ This endpoint remains supported. New integrations should use [Create Items](/data/reference/cms/collection-items/staged-items/create-items), which accepts both request shapes below and can create an item in several locales under one ID. [This guide to creating items](/data/docs/working-with-the-cms/create-items) shows how each shape maps.
+
+
+This endpoint accepts two request shapes, and a request must use one or the other:
+
+- **Single item** — send `fieldData` at the top level. Set `cmsLocaleId` to create the item in a specific locale.
+- **Multiple items** — send an `items` array with at least one entry. Each entry needs its own `fieldData`, and can set its own `cmsLocaleId`, `isDraft`, and `isArchived`. The API ignores any other property on an entry.
+
+```json
+{
+ "items": [
+ {
+ "isArchived": false,
+ "isDraft": false,
+ "fieldData": {
+ "name": "Senior Data Analyst",
+ "slug": "senior-data-analyst"
+ }
+ },
+ {
+ "isArchived": false,
+ "isDraft": false,
+ "fieldData": {
+ "name": "Product Manager",
+ "slug": "product-manager"
+ }
+ }
+ ]
+}
+```
+
+A request that carries both `fieldData` and `items` returns a `400`.
+
+To create an item in several locales under one ID, use [Create Items](/data/reference/cms/collection-items/staged-items/create-items).
+
+Required scope | `CMS:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow, CollectionItemPostSingle, CollectionItemPostSingleFieldData
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.collections.items.create_item(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ skip_invalid_files=True,
+ request=CollectionItemPostSingle(
+ is_archived=False,
+ is_draft=False,
+ field_data=CollectionItemPostSingleFieldData(
+ name="The Hitchhiker\'s Guide to the Galaxy",
+ slug="hitchhikers-guide-to-the-galaxy",
+ ),
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_id:** `str` — Unique identifier for a Collection
+
+
+
+
+
+-
+
+**request:** `ItemsCreateItemRequestBody`
+
+
+
+
+
+-
+
+**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.collections.items.delete_items(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete Items from a Collection.
+
+Items will only be deleted in the primary locale unless a `cmsLocaleId` is included in the request.
+
+Required scope | `CMS:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+from webflow.collections.items import ItemsDeleteItemsRequestItemsItem
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.collections.items.delete_items(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ items=[
+ ItemsDeleteItemsRequestItemsItem(
+ id="580e64008c9a982ac9b8b754",
+ )
+ ],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_id:** `str` — Unique identifier for a Collection
+
+
+
+
+
+-
+
+**items:** `typing.List[ItemsDeleteItemsRequestItemsItem]`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.collections.items.update_items(...) -> ItemsUpdateItemsResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+
+ Rich Text field values can contain Webflow component instances as `` markup — see [Components in Rich Text](/data/docs/working-with-the-cms/components-in-rich-text) for the markup grammar, how to find component and property IDs, and the write constraints.
+
+
+Update a single item or multiple items in a Collection.
+
+The limit for this endpoint is 100 items.
+
+Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request.
+
+
+ `isDraft: true` doesn't unpublish an item. The resulting status depends on whether the item has been published before:
+
+ - **Item that has never been published:** the item gets a `Draft` status.
+ - **Already-published item:** the item gets a `Changes in draft` status. The live item stays published, and your changes are held back until you publish them.
+
+ Setting `isDraft: false` queues the item to publish on the next site publish. To remove an item from the live site, use [Unpublish Live Collection Items](/data/reference/cms/collection-items/live-items/delete-items-live). For the full status mapping, see [Publishing with the CMS API](/data/docs/working-with-the-cms/publishing).
+
+
+Required scope | `CMS:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow, CollectionItemWithIdInput, CollectionItemWithIdInputFieldData
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.collections.items.update_items(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ skip_invalid_files=True,
+ items=[
+ CollectionItemWithIdInput(
+ id="66f6ed9576ddacf3149d5ea6",
+ cms_locale_id="66f6e966c9e1dc700a857ca5",
+ field_data=CollectionItemWithIdInputFieldData(
+ name="Ne Paniquez Pas",
+ slug="ne-paniquez-pas",
+ ),
+ ),
+ CollectionItemWithIdInput(
+ id="66f6ed9576ddacf3149d5ea6",
+ cms_locale_id="66f6e966c9e1dc700a857ca4",
+ field_data=CollectionItemWithIdInputFieldData(
+ name="No Entrar en Pánico",
+ slug="no-entrar-en-panico",
+ ),
+ ),
+ CollectionItemWithIdInput(
+ id="66f6ed9576ddacf3149d5eaa",
+ cms_locale_id="66f6e966c9e1dc700a857ca5",
+ field_data=CollectionItemWithIdInputFieldData(
+ name="Au Revoir et Merci pour Tous les Poissons",
+ slug="au-revoir-et-merci",
+ ),
+ ),
+ CollectionItemWithIdInput(
+ id="66f6ed9576ddacf3149d5eaa",
+ cms_locale_id="66f6e966c9e1dc700a857ca4",
+ field_data=CollectionItemWithIdInputFieldData(
+ name="Hasta Luego y Gracias por Todo el Pescado",
+ slug="hasta-luego-y-gracias",
+ ),
+ )
+ ],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_id:** `str` — Unique identifier for a Collection
+
+
+
+
+
+-
+
+**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
+
+
+
+
+
+-
+
+**items:** `typing.Optional[typing.List[CollectionItemWithIdInput]]`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.collections.items.list_items_live(...) -> CollectionItemList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+
+ Rich Text field values can contain Webflow component instances as `` markup — see [Components in Rich Text](/data/docs/working-with-the-cms/components-in-rich-text) for the markup grammar, how to find component and property IDs, and the write constraints.
+
+
+List all published items in a collection.
+
+
+ Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations.
+
+
+
+ This endpoint supports:
+
+ - Custom `filter[...]` queries support up to 10 filter terms and 2 text-search terms per request.
+ - Custom `sort[...]` queries support up to 3 sort fields per request.
+
+
+Required scope | `CMS:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.collections.items.list_items_live(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ cms_locale_id="cmsLocaleId",
+ offset=1,
+ limit=1,
+ name="name",
+ slug="slug",
+ sort_by="createdOn",
+ sort_order="asc",
+ translatable="65427cf400e02b306eaa04a0",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_id:** `str` — Unique identifier for a Collection
+
+
+
+
+
+-
+
+**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
+
+
+
+
+
+-
+
+**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
+
+
+
+
+
+-
+
+**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+
+
+
+
+
+-
+
+**name:** `typing.Optional[str]` — Filter by the exact name of the item(s)
+
+
+
+
+
+-
+
+**slug:** `typing.Optional[str]` — Filter by the exact slug of the item
+
+
+
+
+
+-
+
+**created_on:** `typing.Optional[ItemsListItemsLiveRequestCreatedOn]` — Filter by the creation date of the item(s)
+
+
+
+
+
+-
+
+**last_published:** `typing.Optional[ItemsListItemsLiveRequestLastPublished]` — Filter by the last published date of the item(s)
+
+
+
+
+
+-
+
+**last_updated:** `typing.Optional[ItemsListItemsLiveRequestLastUpdated]` — Filter by the last updated date of the item(s)
+
+
+
+
+
+-
+
+**filter:** `typing.Optional[typing.Dict[str, typing.Optional[ItemsListItemsLiveRequestFilterValue]]]`
+
+Filter collection items by custom field values. Use bracket notation:
+`filter[][]=`.
+
+Example: `filter[price][gte]=10&filter[price][lte]=100&filter[name][contains]=shirt`.
+
+Filters are combined with AND. You can combine custom field filters with top-level filters such as `name`, `slug`, `createdOn`, `lastPublished`, and `lastUpdated`. OR logic and nested filter groups are not supported on GET requests.
+
+More filter terms can increase request latency.
+
+Supported operators by field type:
+
+| Field type | Supported operators |
+| --- | --- |
+| `id` | `eq`, `ne`, `in`, `nin` |
+| `PlainText` | `eq`, `ne`, `in`, `nin`, `contains`, `ncontains`, `exists` |
+| `Number` | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`, `exists` |
+| `Switch` | `eq`, `ne`, `in`, `nin`, `exists` |
+| `DateTime` | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`, `exists` |
+| `Email`, `Phone`, `Link` | `eq`, `ne`, `in`, `nin`, `contains`, `ncontains`, `exists` |
+| `Color` | `eq`, `ne`, `in`, `nin`, `exists` |
+| `Reference` | `eq`, `ne`, `in`, `nin`, `exists` |
+| `Option` | `eq`, `ne`, `in`, `nin` |
+| `RichText`, `Image`, `MultiImage`, `VideoLink`, `MultiReference` | `exists` |
+
+`contains` and `ncontains` are case-insensitive. `ncontains` also matches items where the field is empty or not set.
+
+`exists=true` matches items where the field has a value. `exists=false` matches items where the field is missing or null. For `Switch` fields, `false` is still a set value.
+
+Value formats:
+
+| Field type | Value format |
+| --- | --- |
+| `Number` | A valid number, such as `10` or `12.5` |
+| `Switch` | `true` or `false` |
+| `DateTime` | ISO 8601 date-time string |
+| `id`, `Reference` | 24-character item ID |
+| `Option` | Option ID |
+| `in`, `nin` | Comma-separated list, up to 100 values |
+
+Invalid fields, invalid values, and operators that do not apply to a field type return a `400 BadArgument` response.
+
+
+
+
+
+-
+
+**sort_by:** `typing.Optional[ItemsListItemsLiveRequestSortBy]` — Sort results by the provided value
+
+
+
+
+
+-
+
+**sort_order:** `typing.Optional[ItemsListItemsLiveRequestSortOrder]` — Sorts the results by asc or desc
+
+
+
+
+
+-
+
+**sort:** `typing.Optional[typing.Dict[str, typing.Optional[ItemsListItemsLiveRequestSortValue]]]`
+
+Sort collection items by custom fields using bracket notation: `sort[]=`.
+
+- Example: `sort[price]=desc`
+- Multiple sort fields are applied in query-string order. When `sort[...]` is provided, it takes precedence over `sortBy` and `sortOrder`.
+- Sortable field types: `PlainText`, `Email`, `Phone`, `Number`, `DateTime`, and `Switch`.
+- Unknown fields, invalid sort directions, and non-sortable field types return a `400 BadArgument` response.
+
+
+
+
+
+-
+
+**translatable:** `typing.Optional[str]`
+
+Unique identifier for the secondary Locale you're translating **into**. Returns only content that hasn't been excluded from translation for that locale.
+
+This is independent of `localeId`, which selects which version of the content is returned. To fetch the source text to translate, request the primary locale's content and set `translatable` to the locale you're translating into:
+
+`?localeId={primary locale id}&translatable={target locale id}`
+
+Only exclusion rules scoped to manual translation are respected — rules scoped only to automatic translation don't affect this parameter's response.
+
+Omitting `translatable` returns the same response as if this parameter didn't exist. The value must be the id of one of the site's secondary locales — the primary locale id, or any other value, returns a `400` error. Requires translation exclusions to be enabled for the site; if they aren't, the request returns a `403` error.
+
+[Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.collections.items.create_item_live(...) -> CollectionItem
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+
+ Rich Text field values can contain Webflow component instances as `` markup — see [Components in Rich Text](/data/docs/working-with-the-cms/components-in-rich-text) for the markup grammar, how to find component and property IDs, and the write constraints.
+
+
+Create item(s) in a collection that will be immediately published to the live site.
+
+This endpoint accepts two request shapes, and a request must use one or the other:
+
+- **Single item** — send `fieldData` at the top level. Set `cmsLocaleId` to create the item in a specific locale.
+- **Multiple items** — send an `items` array with at least one entry. Each entry needs its own `fieldData`, and can set its own `cmsLocaleId`, `isDraft`, and `isArchived`. The API ignores any other property on an entry.
+
+```json
+{
+ "items": [
+ {
+ "isArchived": false,
+ "isDraft": false,
+ "fieldData": {
+ "name": "Senior Data Analyst",
+ "slug": "senior-data-analyst"
+ }
+ },
+ {
+ "isArchived": false,
+ "isDraft": false,
+ "fieldData": {
+ "name": "Product Manager",
+ "slug": "product-manager"
+ }
+ }
+ ]
+}
+```
+
+A request that carries both `fieldData` and `items` returns a `400`.
+
+To create items in several locales, use [Create Items](/data/reference/cms/collection-items/staged-items/create-items) and then [Publish Collection Item(s)](/data/reference/cms/collection-items/staged-items/publish-item). Create Items writes staged content only.
+
+Required scope | `CMS:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow, CollectionItem, CollectionItemFieldData
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.collections.items.create_item_live(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ skip_invalid_files=True,
+ request=CollectionItem(
+ is_archived=False,
+ is_draft=False,
+ field_data=CollectionItemFieldData(
+ name="The Hitchhiker\'s Guide to the Galaxy",
+ slug="hitchhikers-guide-to-the-galaxy",
+ ),
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_id:** `str` — Unique identifier for a Collection
+
+
+
+
+
+-
+
+**request:** `ItemsCreateItemLiveRequestBody`
+
+
+
+
+
+-
+
+**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.collections.items.delete_items_live(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Unpublish up to 100 items from the live site and set the `isDraft` property to `true`.
+
+Items will only be unpublished in the primary locale unless a `cmsLocaleId` is included in the request.
+
+Required scope | `CMS:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+from webflow.collections.items import ItemsDeleteItemsLiveRequestItemsItem
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.collections.items.delete_items_live(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ items=[
+ ItemsDeleteItemsLiveRequestItemsItem(
+ id="580e64008c9a982ac9b8b754",
+ )
+ ],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_id:** `str` — Unique identifier for a Collection
+
+
+
+
+
+-
+
+**items:** `typing.List[ItemsDeleteItemsLiveRequestItemsItem]`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.collections.items.update_items_live(...) -> CollectionItemListNoPagination
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+
+ Rich Text field values can contain Webflow component instances as `` markup — see [Components in Rich Text](/data/docs/working-with-the-cms/components-in-rich-text) for the markup grammar, how to find component and property IDs, and the write constraints.
+
+
+Update a single published item or multiple published items (up to 100) in a Collection
+
+Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request.
+
+Required scope | `CMS:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow, CollectionItemWithIdInput, CollectionItemWithIdInputFieldData
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.collections.items.update_items_live(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ skip_invalid_files=True,
+ items=[
+ CollectionItemWithIdInput(
+ id="66f6ed9576ddacf3149d5ea6",
+ cms_locale_id="66f6e966c9e1dc700a857ca5",
+ field_data=CollectionItemWithIdInputFieldData(
+ name="Ne Paniquez Pas",
+ slug="ne-paniquez-pas",
+ ),
+ ),
+ CollectionItemWithIdInput(
+ id="66f6ed9576ddacf3149d5ea6",
+ cms_locale_id="66f6e966c9e1dc700a857ca4",
+ field_data=CollectionItemWithIdInputFieldData(
+ name="No Entrar en Pánico",
+ slug="no-entrar-en-panico",
+ ),
+ ),
+ CollectionItemWithIdInput(
+ id="66f6ed9576ddacf3149d5eaa",
+ cms_locale_id="66f6e966c9e1dc700a857ca5",
+ field_data=CollectionItemWithIdInputFieldData(
+ name="Au Revoir et Merci pour Tous les Poissons",
+ slug="au-revoir-et-merci",
+ ),
+ ),
+ CollectionItemWithIdInput(
+ id="66f6ed9576ddacf3149d5eaa",
+ cms_locale_id="66f6e966c9e1dc700a857ca4",
+ field_data=CollectionItemWithIdInputFieldData(
+ name="Hasta Luego y Gracias por Todo el Pescado",
+ slug="hasta-luego-y-gracias",
+ ),
+ )
+ ],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_id:** `str` — Unique identifier for a Collection
+
+
+
+
+
+-
+
+**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
+
+
+
+
+
+-
+
+**items:** `typing.Optional[typing.List[CollectionItemWithIdInput]]`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.collections.items.create_items(...) -> BulkCollectionItem
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+
+ Rich Text field values can contain Webflow component instances as `` markup — see [Components in Rich Text](/data/docs/working-with-the-cms/components-in-rich-text) for the markup grammar, how to find component and property IDs, and the write constraints.
+
+
+Create an item or multiple items in a CMS Collection across multiple corresponding locales.
+
+
+ This endpoint remains supported. New integrations should use [Create Items](/data/reference/cms/collection-items/staged-items/create-items), which does everything this endpoint does and can also add locale variants to an existing item. [This guide to creating items](/data/docs/working-with-the-cms/create-items) shows how the request shape maps.
+
+
+
+ - This endpoint can create up to 100 items in a request.
+ - If the `cmsLocaleIds` parameter is not included in the request, an item will only be created in the primary locale.
+
+
+Required scope | `CMS:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+from webflow.collections.items import SingleCmsItem
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.collections.items.create_items(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ skip_invalid_files=True,
+ cms_locale_ids=[
+ "66f6e966c9e1dc700a857ca3",
+ "66f6e966c9e1dc700a857ca4",
+ "66f6e966c9e1dc700a857ca5"
+ ],
+ is_archived=False,
+ is_draft=False,
+ field_data=SingleCmsItem(
+ name="Don’t Panic",
+ slug="dont-panic",
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_id:** `str` — Unique identifier for a Collection
+
+
+
+
+
+-
+
+**field_data:** `CreateBulkCollectionItemRequestBodyFieldData`
+
+
+
+
+
+-
+
+**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
+
+
+
+
+
+-
+
+**cms_locale_ids:** `typing.Optional[typing.List[str]]` — Array of identifiers for the locales where the item will be created
+
+
+
+
+
+-
+
+**is_archived:** `typing.Optional[bool]` — Indicates whether the item is archived.
+
+
+
+
+
+-
+
+**is_draft:** `typing.Optional[bool]` — Indicates whether the item is in draft state.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.collections.items.insert_items(...) -> ItemsInsertItemsResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create one or more staged items in a CMS Collection.
+
+Send an `items` array with `fieldData` for each item. By default, new items are created in the primary locale. To choose other locales or add variants to an existing item, expand the options below.
+
+- **Publishing:** Set `isDraft: false` to queue an item for the next site publish. Items are created as drafts (`isDraft: true`) by default. To publish individual items, use [Publish Collection Item(s)](/data/reference/cms/collection-items/staged-items/publish-item).
+- **Request limit:** Up to 100 items, counting every locale variant across all entries. One item in three locales counts as three; an item in the primary locale only counts as one.
+
+Required scope | `cms:write`
+
+
+
+ Each new item gets one ID. Its locale variants share that ID and the same `fieldData`.
+
+ - **Selected locales:** Set `cmsLocaleIds` to the locale IDs you want to create the item in.
+ - **All site locales:** Set `allCmsLocales: true` to include every current site locale, including the primary locale, without listing IDs.
+ - **Primary locale only:** Omit both `cmsLocaleIds` and `allCmsLocales`.
+
+ Use only one locale selector per entry. `allCmsLocales` is available only for new items and accepts only `true`; omit it instead of sending `false`.
+
+
+
+ Set `id` to an existing item's ID and provide the new locales in `cmsLocaleIds`. The variants reuse that ID. The item must exist and must not already have a variant in any requested locale.
+
+ Send the source content in `fieldData` as a starting point for translators. To provide different content per locale, send multiple entries with the same `id`, each with one locale in `cmsLocaleIds` and its own `fieldData`.
+
+
+
+ These requests return a `400`:
+
+ - Combining `allCmsLocales` with `cmsLocaleIds` (even an empty array) or `id`.
+ - Setting `allCmsLocales` to `false`, a string, or `null`.
+ - Sending unrecognized properties, including singular `cmsLocaleId`. Use `cmsLocaleIds` (plural).
+ - Repeating a locale within one entry, or the same `id`/locale pair across entries.
+
+ Check the response's `message` and `details` for validation errors. Some errors identify an entry, such as `items[2].cmsLocaleIds`. Invalid locale selector combinations return a message with an empty `details` array.
+
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow, InsertCollectionItem, InsertCollectionItemFieldData
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.collections.items.insert_items(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ skip_invalid_files=True,
+ items=[
+ InsertCollectionItem(
+ field_data=InsertCollectionItemFieldData(
+ name="Mostly Harmless",
+ slug="mostly-harmless",
+ ),
+ )
+ ],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_id:** `str` — Unique identifier for a Collection
+
+
+
+
+
+-
+
+**items:** `typing.List[InsertCollectionItem]` — The items to create. A request can create up to 100 items, counted as the sum of the locales across every entry. An `allCmsLocales: true` entry counts once per current site locale; a new-item entry with neither locale selector counts as one.
+
+
+
+
+
+-
+
+**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.collections.items.get_item(...) -> CollectionItem
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+
+ Rich Text field values can contain Webflow component instances as `` markup — see [Components in Rich Text](/data/docs/working-with-the-cms/components-in-rich-text) for the markup grammar, how to find component and property IDs, and the write constraints.
+
+
+Get details of a selected Collection Item.
+
+Required scope | `CMS:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.collections.items.get_item(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ item_id="580e64008c9a982ac9b8b754",
+ cms_locale_id="cmsLocaleId",
+ translatable="65427cf400e02b306eaa04a0",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_id:** `str` — Unique identifier for a Collection
+
+
+
+
+
+-
+
+**item_id:** `str` — Unique identifier for an Item
+
+
+
+
+
+-
+
+**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. This endpoint returns a single item, so it accepts one locale. To retrieve an item in several locales, use [List Collection Items](/data/reference/cms/collection-items/staged-items/list-items) with `filter[id][eq]` and a comma separated `cmsLocaleId`.
+
+
+
+
+
+-
+
+**translatable:** `typing.Optional[str]`
+
+Unique identifier for the secondary Locale you're translating **into**. Returns only content that hasn't been excluded from translation for that locale.
+
+This is independent of `localeId`, which selects which version of the content is returned. To fetch the source text to translate, request the primary locale's content and set `translatable` to the locale you're translating into:
+
+`?localeId={primary locale id}&translatable={target locale id}`
+
+Only exclusion rules scoped to manual translation are respected — rules scoped only to automatic translation don't affect this parameter's response.
+
+Omitting `translatable` returns the same response as if this parameter didn't exist. The value must be the id of one of the site's secondary locales — the primary locale id, or any other value, returns a `400` error. Requires translation exclusions to be enabled for the site; if they aren't, the request returns a `403` error.
+
+[Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.collections.items.delete_item(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete an item from a collection.
+
+Required scope | `CMS:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.collections.items.delete_item(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ item_id="580e64008c9a982ac9b8b754",
+ cms_locale_id="cmsLocaleId",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_id:** `str` — Unique identifier for a Collection
+
+
+
+
+
+-
+
+**item_id:** `str` — Unique identifier for an Item
+
+
+
+
+
+-
+
+**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.collections.items.update_item(...) -> CollectionItem
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+
+ Rich Text field values can contain Webflow component instances as `` markup — see [Components in Rich Text](/data/docs/working-with-the-cms/components-in-rich-text) for the markup grammar, how to find component and property IDs, and the write constraints.
+
+
+Update a selected Item in a Collection.
+
+
+ `isDraft: true` doesn't unpublish an item. The resulting status depends on whether the item has been published before:
+
+ - **Item that has never been published:** the item gets a `Draft` status.
+ - **Already-published item:** the item gets a `Changes in draft` status. The live item stays published, and your changes are held back until you publish them.
+
+ Setting `isDraft: false` queues the item to publish on the next site publish. To remove an item from the live site, use [Unpublish Live Collection Items](/data/reference/cms/collection-items/live-items/delete-items-live). For the full status mapping, see [Publishing with the CMS API](/data/docs/working-with-the-cms/publishing).
+
+
+Required scope | `CMS:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow, CollectionItemPatchSingleFieldData
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.collections.items.update_item(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ item_id="580e64008c9a982ac9b8b754",
+ skip_invalid_files=True,
+ is_archived=False,
+ is_draft=False,
+ field_data=CollectionItemPatchSingleFieldData(
+ name="The Hitchhiker\'s Guide to the Galaxy",
+ slug="hitchhikers-guide-to-the-galaxy",
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_id:** `str` — Unique identifier for a Collection
+
+
+
+
+
+-
+
+**item_id:** `str` — Unique identifier for an Item
+
+
+
+
+
+-
+
+**request:** `CollectionItemPatchSingle`
+
+
+
+
+
+-
+
+**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.collections.items.get_item_live(...) -> CollectionItem
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+
+ Rich Text field values can contain Webflow component instances as `` markup — see [Components in Rich Text](/data/docs/working-with-the-cms/components-in-rich-text) for the markup grammar, how to find component and property IDs, and the write constraints.
+
+
+Get details of a selected Collection live Item.
+
+
+ Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations.
+
+
+Required scope | `CMS:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.collections.items.get_item_live(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ item_id="580e64008c9a982ac9b8b754",
+ cms_locale_id="cmsLocaleId",
+ translatable="65427cf400e02b306eaa04a0",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_id:** `str` — Unique identifier for a Collection
+
+
+
+
+
+-
+
+**item_id:** `str` — Unique identifier for an Item
+
+
+
+
+
+-
+
+**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. This endpoint returns a single item, so it accepts one locale. To retrieve an item in several locales, use [List Collection Items](/data/reference/cms/collection-items/staged-items/list-items) with `filter[id][eq]` and a comma separated `cmsLocaleId`.
+
+
+
+
+
+-
+
+**translatable:** `typing.Optional[str]`
+
+Unique identifier for the secondary Locale you're translating **into**. Returns only content that hasn't been excluded from translation for that locale.
+
+This is independent of `localeId`, which selects which version of the content is returned. To fetch the source text to translate, request the primary locale's content and set `translatable` to the locale you're translating into:
+
+`?localeId={primary locale id}&translatable={target locale id}`
+
+Only exclusion rules scoped to manual translation are respected — rules scoped only to automatic translation don't affect this parameter's response.
+
+Omitting `translatable` returns the same response as if this parameter didn't exist. The value must be the id of one of the site's secondary locales — the primary locale id, or any other value, returns a `400` error. Requires translation exclusions to be enabled for the site; if they aren't, the request returns a `403` error.
+
+[Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.collections.items.delete_item_live(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Unpublish a live item from the site and set the `isDraft` property to `true`.
+
+For bulk unpublishing, please use [this endpoint.](/data/v2.0.0/reference/cms/collection-items/live-items/delete-items-live)
+
+Required scope | `CMS:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.collections.items.delete_item_live(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ item_id="580e64008c9a982ac9b8b754",
+ cms_locale_id="cmsLocaleId",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_id:** `str` — Unique identifier for a Collection
+
+
+
+
+
+-
+
+**item_id:** `str` — Unique identifier for an Item
+
+
+
+
+
+-
+
+**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.collections.items.update_item_live(...) -> CollectionItem
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+
+ Rich Text field values can contain Webflow component instances as `` markup — see [Components in Rich Text](/data/docs/working-with-the-cms/components-in-rich-text) for the markup grammar, how to find component and property IDs, and the write constraints.
+
+
+Update a selected live Item in a Collection. The updates for this Item will be published to the live site.
+
+Required scope | `CMS:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow, CollectionItemPatchSingleFieldData
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.collections.items.update_item_live(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ item_id="580e64008c9a982ac9b8b754",
+ skip_invalid_files=True,
+ is_archived=False,
+ is_draft=False,
+ field_data=CollectionItemPatchSingleFieldData(
+ name="The Hitchhiker\'s Guide to the Galaxy",
+ slug="hitchhikers-guide-to-the-galaxy",
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_id:** `str` — Unique identifier for a Collection
+
+
+
+
+
+-
+
+**item_id:** `str` — Unique identifier for an Item
+
+
+
+
+
+-
+
+**request:** `CollectionItemPatchSingle`
+
+
+
+
+
+-
+
+**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.collections.items.publish_item(...) -> ItemsPublishItemResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Publish an item or multiple items.
+
+Publishing a draft item automatically sets `isDraft` to `false`.
+You don't need to update the item's draft status before calling this endpoint.
+
+Required scope | `cms:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+from webflow.collections.items import ItemIDs
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.collections.items.publish_item(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ request=ItemIDs(
+ item_ids=[
+ "643fd856d66b6528195ee2ca",
+ "643fd856d66b6528195ee2cb",
+ "643fd856d66b6528195ee2cc"
+ ],
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_id:** `str` — Unique identifier for a Collection
+
+
+
+
+
+-
+
+**request:** `ItemsPublishItemRequest`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.optimize.optimizations.list(...) -> OptimizationListResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Lists the optimizations for an `optimizeId`, with each one's type, status, intervals, and current goals. Returns live and draft optimizations unless you set `status`.
+
+Each report covers a date range within a single interval of an optimization. Use an interval's `start` and `end` to choose a report's `intervalStart` and `intervalEnd`.
+
+Each interval lists its goals as they were when it started. `currentGoals` lists the optimization's goals as they're set up now, and each goal's `source` shows where it comes from. A report accepts a `goalId` from either list.
+
+Results are sorted by `optimizationId`, and each optimization's intervals are listed oldest first. To get the next page, pass `nextCursor` as `cursor`.
+
+This endpoint requires a Webflow site with the Optimize add-on, or a non-Webflow site that uses Optimize.
+
+Each access token can have one Optimize request in flight at a time, across all Optimize endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.optimize.optimizations.list(
+ optimize_id="117420042",
+ status=[
+ "live",
+ "draft"
+ ],
+ page_size=1,
+ cursor="c2xhcnRpYmFydGZhc3Q",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**optimize_id:** `str` — The Optimize ID, from [List Optimize IDs](/data/reference/optimize/list-optimize-ids).
+
+
+
+
+
+-
+
+**status:** `typing.Optional[typing.Union[OptimizationStatus, typing.Sequence[OptimizationStatus]]]`
+
+The statuses to include. Defaults to `live` and `draft`. Pass repeated values (`status=live&status=draft`) or a comma-separated list (`status=live,draft`).
+
+A `cursor` keeps the statuses it was created with. When you pass a `cursor`, omit `status` or send the same statuses.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — The maximum number of results to return. Defaults to `100`, up to `200`.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The `nextCursor` from a previous response, to get the next page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.optimize.optimizations.summary(...) -> OptimizationSummaryResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns each variation's sessions, users, conversions, and conversion rate for one goal, over a date range within one interval. Traditional tests and AI-optimized optimizations also include each variation's comparison with the base variation.
+
+Value goals also include each variation's total value and average conversion value. Choose the goal with `goalId`, and narrow the results with `filter`.
+
+This endpoint requires a Webflow site with the Optimize add-on, or a non-Webflow site that uses Optimize.
+
+Each access token can have one Optimize request in flight at a time, across all Optimize endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+import datetime
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.optimize.optimizations.summary(
+ optimize_id="117420042",
+ optimization_id="417200971",
+ interval_start=datetime.datetime.fromisoformat("2026-09-01T00:00:00+00:00"),
+ interval_end=datetime.datetime.fromisoformat("2026-09-15T00:00:00+00:00"),
+ goal_id="198042421",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**optimize_id:** `str` — The Optimize ID, from [List Optimize IDs](/data/reference/optimize/list-optimize-ids).
+
+
+
+
+
+-
+
+**optimization_id:** `str` — The optimization ID, from [List Optimizations](/data/reference/optimize/list-optimizations).
+
+
+
+
+
+-
+
+**interval_start:** `datetime.datetime` — Start of the date range. Must be a UTC timestamp ending in `Z`, such as `2026-09-01T00:00:00Z`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional. The date range must fall within a single interval of the optimization. A range that crosses from one interval into the next is rejected. Use an interval's `start` and `end` from [List Optimizations](/data/reference/optimize/list-optimizations). Can't be earlier than 18 months ago.
+
+
+
+
+
+-
+
+**interval_end:** `datetime.datetime` — End of the date range. Must be a UTC timestamp ending in `Z`, such as `2026-09-15T00:00:00Z`, and later than `intervalStart`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional.
+
+
+
+
+
+-
+
+**goal_id:** `typing.Optional[str]`
+
+The goal to measure. Defaults to the interval's first target goal, or its first goal if it has no target goal. Use a `goalId` from the interval's `goals` or from the optimization's `currentGoals`. See [List Optimization Goals](/data/reference/optimize/list-optimization-goals).
+
+If the goal is in both lists, the report uses the interval's version. A goal from `currentGoals` is measured with its current settings over the whole date range, including dates before it was added to the optimization.
+
+
+
+
+
+-
+
+**filter:** `typing.Optional[OptimizeFilter]`
+
+Narrow the results to visitors who match dimension values. Use bracket notation with `in` or `nin` and indexed arrays, for example `filter[country][in][0]=US&filter[country][in][1]=GB&filter[customAttribute:towel][nin][0]=forgotten`.
+
+Keys are dimension `id` values from [List Dimensions](/data/reference/optimize/list-dimensions), and values are raw `value` values from [List Dimension Values](/data/reference/optimize/list-dimension-values). Separate dimensions combine with AND. Values within one dimension combine with OR. A filter can name at most 20 dimensions, with at most 50 values per operator and 500 values in total.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.optimize.optimizations.audience_insights(...) -> OptimizationAudienceInsightsResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns each variation's sessions, users, conversions, and conversion rate for each segment of one dimension, for one goal over a date range within one interval. Choose the dimension with `groupBy`.
+
+Each segment also shows how the variation is trending against the base variation in that segment, and how confident that trend is. Choose the goal with `goalId`, and narrow the results with `filter`.
+
+This endpoint requires a Webflow site with the Optimize add-on, or a non-Webflow site that uses Optimize.
+
+Each access token can have one Optimize request in flight at a time, across all Optimize endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+import datetime
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.optimize.optimizations.audience_insights(
+ optimize_id="117420042",
+ optimization_id="417200971",
+ interval_start=datetime.datetime.fromisoformat("2026-09-01T00:00:00+00:00"),
+ interval_end=datetime.datetime.fromisoformat("2026-09-15T00:00:00+00:00"),
+ group_by="country",
+ goal_id="198042421",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**optimize_id:** `str` — The Optimize ID, from [List Optimize IDs](/data/reference/optimize/list-optimize-ids).
+
+
+
+
+
+-
+
+**optimization_id:** `str` — The optimization ID, from [List Optimizations](/data/reference/optimize/list-optimizations).
+
+
+
+
+
+-
+
+**interval_start:** `datetime.datetime` — Start of the date range. Must be a UTC timestamp ending in `Z`, such as `2026-09-01T00:00:00Z`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional. The date range must fall within a single interval of the optimization. A range that crosses from one interval into the next is rejected. Use an interval's `start` and `end` from [List Optimizations](/data/reference/optimize/list-optimizations). Can't be earlier than 18 months ago.
+
+
+
+
+
+-
+
+**interval_end:** `datetime.datetime` — End of the date range. Must be a UTC timestamp ending in `Z`, such as `2026-09-15T00:00:00Z`, and later than `intervalStart`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional.
+
+
+
+
+
+-
+
+**group_by:** `str` — The dimension to split results by, from [List Dimensions](/data/reference/optimize/list-dimensions). Accepts any dimension except `urlParameter`.
+
+
+
+
+
+-
+
+**goal_id:** `typing.Optional[str]`
+
+The goal to measure. Defaults to the interval's first target goal, or its first goal if it has no target goal. Use a `goalId` from the interval's `goals` or from the optimization's `currentGoals`. See [List Optimization Goals](/data/reference/optimize/list-optimization-goals).
+
+If the goal is in both lists, the report uses the interval's version. A goal from `currentGoals` is measured with its current settings over the whole date range, including dates before it was added to the optimization.
+
+
+
+
+
+-
+
+**filter:** `typing.Optional[OptimizeFilter]`
+
+Narrow the results to visitors who match dimension values. Use bracket notation with `in` or `nin` and indexed arrays, for example `filter[country][in][0]=US&filter[country][in][1]=GB&filter[customAttribute:towel][nin][0]=forgotten`.
+
+Keys are dimension `id` values from [List Dimensions](/data/reference/optimize/list-dimensions), and values are raw `value` values from [List Dimension Values](/data/reference/optimize/list-dimension-values). Separate dimensions combine with AND. Values within one dimension combine with OR. A filter can name at most 20 dimensions, with at most 50 values per operator and 500 values in total.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.optimize.optimizations.trend(...) -> OptimizationTrendResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns each variation's sessions, users, conversions, and conversion rate by day or week, for one goal over a date range within one interval. Traditional tests and AI-optimized optimizations also include each variation's comparison with the base variation.
+
+Buckets use the account's time zone, returned as `timeZone`. For AI-optimized optimizations, `strength` covers the whole date range and is the same in every bucket. Choose the goal with `goalId`, and narrow the results with `filter`.
+
+This endpoint requires a Webflow site with the Optimize add-on, or a non-Webflow site that uses Optimize.
+
+Each access token can have one Optimize request in flight at a time, across all Optimize endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+import datetime
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.optimize.optimizations.trend(
+ optimize_id="117420042",
+ optimization_id="417200971",
+ interval_start=datetime.datetime.fromisoformat("2026-09-01T00:00:00+00:00"),
+ interval_end=datetime.datetime.fromisoformat("2026-09-15T00:00:00+00:00"),
+ granularity="daily",
+ goal_id="198042421",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**optimize_id:** `str` — The Optimize ID, from [List Optimize IDs](/data/reference/optimize/list-optimize-ids).
+
+
+
+
+
+-
+
+**optimization_id:** `str` — The optimization ID, from [List Optimizations](/data/reference/optimize/list-optimizations).
+
+
+
+
+
+-
+
+**interval_start:** `datetime.datetime` — Start of the date range. Must be a UTC timestamp ending in `Z`, such as `2026-09-01T00:00:00Z`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional. The date range must fall within a single interval of the optimization. A range that crosses from one interval into the next is rejected. Use an interval's `start` and `end` from [List Optimizations](/data/reference/optimize/list-optimizations). Can't be earlier than 18 months ago.
+
+
+
+
+
+-
+
+**interval_end:** `datetime.datetime` — End of the date range. Must be a UTC timestamp ending in `Z`, such as `2026-09-15T00:00:00Z`, and later than `intervalStart`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional.
+
+
+
+
+
+-
+
+**granularity:** `OptimizeTrendGranularity` — Whether to bucket results by day or by week.
+
+
+
+
+
+-
+
+**goal_id:** `typing.Optional[str]`
+
+The goal to measure. Defaults to the interval's first target goal, or its first goal if it has no target goal. Use a `goalId` from the interval's `goals` or from the optimization's `currentGoals`. See [List Optimization Goals](/data/reference/optimize/list-optimization-goals).
+
+If the goal is in both lists, the report uses the interval's version. A goal from `currentGoals` is measured with its current settings over the whole date range, including dates before it was added to the optimization.
+
+
+
+
+
+-
+
+**filter:** `typing.Optional[OptimizeFilter]`
+
+Narrow the results to visitors who match dimension values. Use bracket notation with `in` or `nin` and indexed arrays, for example `filter[country][in][0]=US&filter[country][in][1]=GB&filter[customAttribute:towel][nin][0]=forgotten`.
+
+Keys are dimension `id` values from [List Dimensions](/data/reference/optimize/list-dimensions), and values are raw `value` values from [List Dimension Values](/data/reference/optimize/list-dimension-values). Separate dimensions combine with AND. Values within one dimension combine with OR. A filter can name at most 20 dimensions, with at most 50 values per operator and 500 values in total.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.optimize.optimizations.goals.list(...) -> OptimizationGoalsResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Lists an optimization's goals in two lists. `goals` holds the goals of the interval that contains the requested date range, as they were when it started, with its target goals marked. `currentGoals` holds the optimization's goals as they're set up now, with where each comes from. Use a `goalId` from either list to choose the goal a report measures.
+
+This endpoint requires a Webflow site with the Optimize add-on, or a non-Webflow site that uses Optimize.
+
+Each access token can have one Optimize request in flight at a time, across all Optimize endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+import datetime
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.optimize.optimizations.goals.list(
+ optimize_id="117420042",
+ optimization_id="417200971",
+ interval_start=datetime.datetime.fromisoformat("2026-09-01T00:00:00+00:00"),
+ interval_end=datetime.datetime.fromisoformat("2026-09-15T00:00:00+00:00"),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**optimize_id:** `str` — The Optimize ID, from [List Optimize IDs](/data/reference/optimize/list-optimize-ids).
+
+
+
+
+
+-
+
+**optimization_id:** `str` — The optimization ID, from [List Optimizations](/data/reference/optimize/list-optimizations).
+
+
+
+
+
+-
+
+**interval_start:** `datetime.datetime` — Start of the date range. Must be a UTC timestamp ending in `Z`, such as `2026-09-01T00:00:00Z`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional. The date range must fall within a single interval of the optimization. A range that crosses from one interval into the next is rejected. Use an interval's `start` and `end` from [List Optimizations](/data/reference/optimize/list-optimizations). Unlike the report endpoints, this endpoint has no 18-month limit.
+
+
+
+
+
+-
+
+**interval_end:** `datetime.datetime` — End of the date range. Must be a UTC timestamp ending in `Z`, such as `2026-09-15T00:00:00Z`, and later than `intervalStart`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.optimize.optimizations.dimensions.list(...) -> OptimizationDimensionsResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Lists the dimensions you can group or filter an optimization's reports by, for a date range within one interval. Use a dimension's `id` in `groupBy`, in `filter`, or to list its values.
+
+This endpoint requires a Webflow site with the Optimize add-on, or a non-Webflow site that uses Optimize.
+
+Each access token can have one Optimize request in flight at a time, across all Optimize endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+import datetime
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.optimize.optimizations.dimensions.list(
+ optimize_id="117420042",
+ optimization_id="417200971",
+ interval_start=datetime.datetime.fromisoformat("2026-09-01T00:00:00+00:00"),
+ interval_end=datetime.datetime.fromisoformat("2026-09-15T00:00:00+00:00"),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**optimize_id:** `str` — The Optimize ID, from [List Optimize IDs](/data/reference/optimize/list-optimize-ids).
+
+
+
+
+
+-
+
+**optimization_id:** `str` — The optimization ID, from [List Optimizations](/data/reference/optimize/list-optimizations).
+
+
+
+
+
+-
+
+**interval_start:** `datetime.datetime` — Start of the date range. Must be a UTC timestamp ending in `Z`, such as `2026-09-01T00:00:00Z`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional. The date range must fall within a single interval of the optimization. A range that crosses from one interval into the next is rejected. Use an interval's `start` and `end` from [List Optimizations](/data/reference/optimize/list-optimizations). Can't be earlier than 18 months ago.
+
+
+
+
+
+-
+
+**interval_end:** `datetime.datetime` — End of the date range. Must be a UTC timestamp ending in `Z`, such as `2026-09-15T00:00:00Z`, and later than `intervalStart`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.optimize.optimizations.dimensions.list_values(...) -> OptimizationDimensionValuesResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Lists the values seen for one dimension over a date range within one interval, with how often each appeared. Use a `value` in `filter` to narrow a report.
+
+Values are sorted by `eventCount`, highest first. To get the next page, pass `nextCursor` as `cursor`. Counts can change between requests, so a value can move to a different page while you page through the list.
+
+This endpoint requires a Webflow site with the Optimize add-on, or a non-Webflow site that uses Optimize.
+
+Each access token can have one Optimize request in flight at a time, across all Optimize endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+import datetime
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.optimize.optimizations.dimensions.list_values(
+ optimize_id="117420042",
+ optimization_id="417200971",
+ dimension_id="country",
+ interval_start=datetime.datetime.fromisoformat("2026-09-01T00:00:00+00:00"),
+ interval_end=datetime.datetime.fromisoformat("2026-09-15T00:00:00+00:00"),
+ page_size=1,
+ cursor="ZmpvcmRz",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**optimize_id:** `str` — The Optimize ID, from [List Optimize IDs](/data/reference/optimize/list-optimize-ids).
+
+
+
+
+
+-
+
+**optimization_id:** `str` — The optimization ID, from [List Optimizations](/data/reference/optimize/list-optimizations).
+
+
+
+
+
+-
+
+**dimension_id:** `str` — The dimension `id`, from [List Dimensions](/data/reference/optimize/list-dimensions). URL-encode it, because dimension IDs can contain `:`, `.`, and spaces. Unlike `groupBy`, this accepts `urlParameter`.
+
+
+
+
+
+-
+
+**interval_start:** `datetime.datetime` — Start of the date range. Must be a UTC timestamp ending in `Z`, such as `2026-09-01T00:00:00Z`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional. The date range must fall within a single interval of the optimization. A range that crosses from one interval into the next is rejected. Use an interval's `start` and `end` from [List Optimizations](/data/reference/optimize/list-optimizations). Can't be earlier than 18 months ago.
+
+
+
+
+
+-
+
+**interval_end:** `datetime.datetime` — End of the date range. Must be a UTC timestamp ending in `Z`, such as `2026-09-15T00:00:00Z`, and later than `intervalStart`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional.
+
+
+
+
+
+-
+
+**filter:** `typing.Optional[OptimizeFilter]`
+
+Narrow the results to visitors who match dimension values. Use bracket notation with `in` or `nin` and indexed arrays, for example `filter[country][in][0]=US&filter[country][in][1]=GB&filter[customAttribute:towel][nin][0]=forgotten`.
+
+Keys are dimension `id` values from [List Dimensions](/data/reference/optimize/list-dimensions), and values are raw `value` values from [List Dimension Values](/data/reference/optimize/list-dimension-values). Separate dimensions combine with AND. Values within one dimension combine with OR. A filter can name at most 20 dimensions, with at most 50 values per operator and 500 values in total.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — The maximum number of results to return. Defaults to `100`, up to `200`.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The `nextCursor` from a previous response, to get the next page. Send the same dimension, `intervalStart`, `intervalEnd`, and `filter` as the original request. Note that `pageSize` can differ between requests.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.pages.scripts.get_custom_code(...) -> ScriptApplyList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all scripts applied to a page.
+
+Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).
+
+Required scope | `custom_code:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.pages.scripts.get_custom_code(
+ page_id="63c720f9347c2139b248e552",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**page_id:** `str` — Unique identifier for a Page
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.pages.scripts.upsert_custom_code(...) -> ScriptApplyList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Apply registered scripts to a page. If you have multiple scripts your App needs to apply or maintain on a page, ensure they are always included in the request body for this endpoint. To remove individual scripts, simply call this endpoint without the script in the request body.
+
+
+ To apply a script to a page, the script must first be registered to a Site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
+
+
+Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).
+
+Required scope | `custom_code:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow, ScriptApply
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.pages.scripts.upsert_custom_code(
+ page_id="63c720f9347c2139b248e552",
+ scripts=[
+ ScriptApply(
+ id="cms_slider",
+ location="header",
+ version="1.0.0",
+ attributes={
+ "my-attribute": "some-value"
+ },
+ ),
+ ScriptApply(
+ id="alert",
+ location="header",
+ version="0.0.1",
+ )
+ ],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**page_id:** `str` — Unique identifier for a Page
+
+
+
+
+
+-
+
+**request:** `ScriptApplyList`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.pages.scripts.delete_custom_code(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Remove all scripts from a page applied by the App. This endpoint will not remove scripts from the site's registered scripts.
+
+To remove individual scripts applied by the App, use the [Add/Update Custom Code](/data/reference/custom-code/custom-code-pages/upsert-custom-code) endpoint.
+
+Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).
+
+Required scope | `custom_code:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.pages.scripts.delete_custom_code(
+ page_id="63c720f9347c2139b248e552",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**page_id:** `str` — Unique identifier for a Page
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.sites.redirects.list(...) -> Redirects
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Fetch a list of all 301 redirect rules configured for a specific site.
+
+Use this endpoint to review, audit, or manage the redirection rules that control how traffic is rerouted on your site.
+
+This endpoint requires an Enterprise workspace.
+
+Required scope: `sites:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.sites.redirects.list(
+ site_id="580e63e98c9a982ac9b8b741",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.sites.redirects.create(...) -> Redirect
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Add a new 301 redirection rule to a site.
+
+This endpoint allows you to define a source path (`fromUrl`) and its corresponding destination path (`toUrl`), which will dictate how traffic is rerouted on your site. This is useful for managing site changes, restructuring URLs, or handling outdated links.
+
+This endpoint requires an Enterprise workspace.
+
+Required scope: `sites:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.sites.redirects.create(
+ site_id="580e63e98c9a982ac9b8b741",
+ id="42e1a2b7aa1a13f768a0042a",
+ from_url="/mostly-harmless",
+ to_url="/earth",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**request:** `Redirect`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.sites.redirects.delete(...) -> Redirects
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Remove a 301 redirection rule from a site.
+
+This is useful for cleaning up outdated or unnecessary redirects, ensuring that your site's routing behavior remains efficient and up-to-date.
+
+This endpoint requires an Enterprise workspace.
+
+Required scope: `sites:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.sites.redirects.delete(
+ site_id="580e63e98c9a982ac9b8b741",
+ redirect_id="66c4cb9a20cac35ed19500e6",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**redirect_id:** `str` — Unique identifier site redirect
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.sites.redirects.update(...) -> Redirect
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Update a 301 redirection rule from a site.
+
+This endpoint requires an Enterprise workspace.
+
+Required scope: `sites:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.sites.redirects.update(
+ site_id="580e63e98c9a982ac9b8b741",
+ redirect_id="66c4cb9a20cac35ed19500e6",
+ id="42e1a2b7aa1a13f768a0042a",
+ from_url="/mostly-harmless",
+ to_url="/earth",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**redirect_id:** `str` — Unique identifier site redirect
+
+
+
+
+
+-
+
+**request:** `Redirect`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.sites.plans.get_site_plan(...) -> SitePlan
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get site plan details for the specified Site.
+
+This endpoint requires an Enterprise workspace.
+
+Required scope | `sites:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.sites.plans.get_site_plan(
+ site_id="580e63e98c9a982ac9b8b741",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.sites.robots_txt.get(...) -> Robots
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieve the robots.txt configuration for various user agents.
+
+This endpoint requires an Enterprise workspace.
+
+Required scope: `site_config:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.sites.robots_txt.get(
+ site_id="580e63e98c9a982ac9b8b741",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.sites.robots_txt.put(...) -> Robots
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Replace the `robots.txt` configuration for various user agents.
+
+This endpoint requires an Enterprise workspace.
+
+Required scope | `site_config:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow, RobotsRulesItem
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.sites.robots_txt.put(
+ site_id="580e63e98c9a982ac9b8b741",
+ rules=[
+ RobotsRulesItem(
+ user_agent="googlebot",
+ allows=[
+ "/public"
+ ],
+ disallows=[
+ "/vogon-poetry",
+ "/total-perspective-vortex"
+ ],
+ )
+ ],
+ sitemap="https://heartofgold.ship/sitemap.xml",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**request:** `Robots`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.sites.robots_txt.delete(...) -> Robots
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Remove specific rules for a user-agent in your `robots.txt` file. To delete all rules for a user-agent, provide an empty rule set. This will remove the user-agent's entry entirely, leaving it subject to your site's default crawling behavior.
+
+**Note:** Deleting a user-agent with no rules will make the user-agent's access unrestricted unless other directives apply.
+
+This endpoint requires an Enterprise workspace.
+
+Required scope: `site_config:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow, RobotsRulesItem
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.sites.robots_txt.delete(
+ site_id="580e63e98c9a982ac9b8b741",
+ rules=[
+ RobotsRulesItem(
+ user_agent="*",
+ allows=[
+ "/public"
+ ],
+ disallows=[
+ "/bubbles"
+ ],
+ )
+ ],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**request:** `Robots`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.sites.robots_txt.patch(...) -> Robots
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Update the `robots.txt` configuration for various user agents.
+
+This endpoint requires an Enterprise workspace.
+
+Required scope | `site_config:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow, RobotsRulesItem
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.sites.robots_txt.patch(
+ site_id="580e63e98c9a982ac9b8b741",
+ rules=[
+ RobotsRulesItem(
+ user_agent="googlebot",
+ allows=[
+ "/public"
+ ],
+ disallows=[
+ "/vogon-poetry",
+ "/total-perspective-vortex"
+ ],
+ )
+ ],
+ sitemap="https://heartofgold.ship/sitemap.xml",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**request:** `Robots`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.sites.well_known.put(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Upload a supported well-known file to a site.
+
+The current restrictions on well-known files are as follows:
+ - Each file must be smaller than 100kb
+ - Less than 30 total files
+ - Have one of the following file extensions (or no extension): `.txt`, `.json`, `.noext`
+
+
+ `.noext` is a special file extension that removes other extensions. For example, `apple-app-site-association.noext.txt` will be uploaded as `apple-app-site-association`. Use this extension for tools that have trouble uploading extensionless files.
+
+
+This endpoint requires an Enterprise workspace.
+
+Required scope: `site_config:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.sites.well_known.put(
+ site_id="580e63e98c9a982ac9b8b741",
+ file_name="apple-app-site-association.txt",
+ file_data="{\n \"applinks\": {\n \"apps\": [],\n \"details\": [\n {\n \"appID\": \"ABCDE12345.com.example.app\",\n \"paths\": [ \"/*\", \"/some/path/*\" ]\n }\n ]\n }\n}\n",
+ content_type="application/json",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**file_name:** `str` — The name of the file
+
+
+
+
+
+-
+
+**file_data:** `str` — The contents of the file
+
+
+
+
+
+-
+
+**content_type:** `typing.Optional[WellKnownFileContentType]` — The content type of the file. Defaults to application/json
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.sites.well_known.delete(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete existing well-known files from a site.
+
+This endpoint requires an Enterprise workspace.
+
+Required scope: `site_config:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.sites.well_known.delete(
+ site_id="580e63e98c9a982ac9b8b741",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**file_names:** `typing.Optional[typing.List[str]]` — A list of file names to delete
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.sites.google_tag.list(...) -> GoogleTagIds
-
@@ -6117,12 +13664,84 @@ client.collections.items.list_items(
-
-Create Item(s) in a Collection.
+List all Google Tag IDs configured for a site, sorted by order.
+
+Required scope: `sites:read`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.sites.google_tag.list(
+ site_id="580e63e98c9a982ac9b8b741",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
-To create items across multiple locales, please use [this endpoint.](/data/reference/cms/collection-items/staged-items/create-items)
-Required scope | `CMS:write`
+
+
+client.sites.google_tag.delete_all(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete all Google Tag IDs from a site.
+
+Required scope: `sites:write`
@@ -6137,7 +13756,7 @@ Required scope | `CMS:write`
-
```python
-from webflow import Webflow, CollectionItemPostSingle, CollectionItemPostSingleFieldData
+from webflow import Webflow
from webflow.environment import WebflowEnvironment
client = Webflow(
@@ -6145,17 +13764,8 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.collections.items.create_item(
- collection_id="580e63fc8c9a982ac9b8b745",
- skip_invalid_files=True,
- request=CollectionItemPostSingle(
- is_archived=False,
- is_draft=False,
- field_data=CollectionItemPostSingleFieldData(
- name="The Hitchhiker\'s Guide to the Galaxy",
- slug="hitchhikers-guide-to-the-galaxy",
- ),
- ),
+client.sites.google_tag.delete_all(
+ site_id="580e63e98c9a982ac9b8b741",
)
```
@@ -6172,7 +13782,7 @@ client.collections.items.create_item(
-
-**collection_id:** `str` — Unique identifier for a Collection
+**site_id:** `str` — Unique identifier for a Site
@@ -6180,15 +13790,91 @@ client.collections.items.create_item(
-
-**request:** `ItemsCreateItemRequestBody`
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+client.sites.google_tag.upsert(...) -> GoogleTagIds
-
-**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
+#### 📝 Description
+
+
+-
+
+
+-
+
+Add or update Google Tag IDs for a site. Existing tags not referenced in the request are preserved. A site may have a maximum of 25 tags total.
+
+`order` is optional on input — it is auto-assigned for new tags and returned on all tags in the response.
+
+Required scope: `sites:write`
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from webflow import Webflow, GoogleTagId
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.sites.google_tag.upsert(
+ site_id="580e63e98c9a982ac9b8b741",
+ google_tag_ids=[
+ GoogleTagId(
+ order=0,
+ display_name="Main Analytics Tag",
+ tag_id="G-1234567890",
+ )
+ ],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**request:** `GoogleTagIds`
@@ -6208,7 +13894,7 @@ client.collections.items.create_item(
client.collections.items.delete_items(...)
+client.sites.google_tag.delete(...) -> GoogleTagIds
-
@@ -6220,11 +13906,9 @@ client.collections.items.create_item(
-
-Delete Items from a Collection.
-
-Items will only be deleted in the primary locale unless a `cmsLocaleId` is included in the request.
+Delete a single Google Tag ID from a site. The `order` values of the remaining tags are renormalized after deletion.
-Required scope | `CMS:write`
+Required scope: `sites:write`
@@ -6241,20 +13925,15 @@ Required scope | `CMS:write`
```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
-from webflow.collections.items import ItemsDeleteItemsRequestItemsItem
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.collections.items.delete_items(
- collection_id="580e63fc8c9a982ac9b8b745",
- items=[
- ItemsDeleteItemsRequestItemsItem(
- id="580e64008c9a982ac9b8b754",
- )
- ],
+client.sites.google_tag.delete(
+ site_id="580e63e98c9a982ac9b8b741",
+ tag_id="G-XXXXXXXXXX",
)
```
@@ -6271,7 +13950,7 @@ client.collections.items.delete_items(
-
-**collection_id:** `str` — Unique identifier for a Collection
+**site_id:** `str` — Unique identifier for a Site
@@ -6279,7 +13958,7 @@ client.collections.items.delete_items(
-
-**items:** `typing.List[ItemsDeleteItemsRequestItemsItem]`
+**tag_id:** `str` — The Google Tag ID (e.g. G-XXXXXXXXXX)
@@ -6299,7 +13978,8 @@ client.collections.items.delete_items(
client.collections.items.update_items(...) -> ItemsUpdateItemsResponse
+## Sites Members
+client.sites.members.list_members(...) -> SiteMembersResponse
-
@@ -6311,13 +13991,11 @@ client.collections.items.delete_items(
-
-Update a single item or multiple items in a Collection.
-
-The limit for this endpoint is 100 items.
+List the members of a site and the role each holds.
-Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request.
+This endpoint requires an Enterprise workspace.
-Required scope | `CMS:write`
+Required scope | `site_access:read`
@@ -6332,7 +14010,7 @@ Required scope | `CMS:write`
-
```python
-from webflow import Webflow, CollectionItemWithIdInput, CollectionItemWithIdInputFieldData
+from webflow import Webflow
from webflow.environment import WebflowEnvironment
client = Webflow(
@@ -6340,43 +14018,11 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.collections.items.update_items(
- collection_id="580e63fc8c9a982ac9b8b745",
- skip_invalid_files=True,
- items=[
- CollectionItemWithIdInput(
- id="66f6ed9576ddacf3149d5ea6",
- cms_locale_id="66f6e966c9e1dc700a857ca5",
- field_data=CollectionItemWithIdInputFieldData(
- name="Ne Paniquez Pas",
- slug="ne-paniquez-pas",
- ),
- ),
- CollectionItemWithIdInput(
- id="66f6ed9576ddacf3149d5ea6",
- cms_locale_id="66f6e966c9e1dc700a857ca4",
- field_data=CollectionItemWithIdInputFieldData(
- name="No Entrar en Pánico",
- slug="no-entrar-en-panico",
- ),
- ),
- CollectionItemWithIdInput(
- id="66f6ed9576ddacf3149d5eaa",
- cms_locale_id="66f6e966c9e1dc700a857ca5",
- field_data=CollectionItemWithIdInputFieldData(
- name="Au Revoir et Merci pour Tous les Poissons",
- slug="au-revoir-et-merci",
- ),
- ),
- CollectionItemWithIdInput(
- id="66f6ed9576ddacf3149d5eaa",
- cms_locale_id="66f6e966c9e1dc700a857ca4",
- field_data=CollectionItemWithIdInputFieldData(
- name="Hasta Luego y Gracias por Todo el Pescado",
- slug="hasta-luego-y-gracias",
- ),
- )
- ],
+client.sites.members.list_members(
+ site_id="580e63e98c9a982ac9b8b741",
+ limit=1,
+ email="email",
+ cursor="cursor",
)
```
@@ -6393,7 +14039,7 @@ client.collections.items.update_items(
-
-**collection_id:** `str` — Unique identifier for a Collection
+**site_id:** `str` — Unique identifier for a Site
@@ -6401,7 +14047,7 @@ client.collections.items.update_items(
-
-**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
+**limit:** `typing.Optional[int]` — Maximum number of records to return. Defaults to `50`, up to a maximum of `100`.
@@ -6409,7 +14055,15 @@ client.collections.items.update_items(
-
-**items:** `typing.Optional[typing.List[CollectionItemWithIdInput]]`
+**email:** `typing.Optional[str]` — Filter to the Site Member with this email address
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — Cursor returned in `pagination.nextCursor` of the previous response
@@ -6429,7 +14083,7 @@ client.collections.items.update_items(
client.collections.items.list_items_live(...) -> CollectionItemList
+client.sites.members.add_member(...) -> SiteMember
-
@@ -6441,13 +14095,13 @@ client.collections.items.update_items(
-
-List all published items in a collection.
+Grant a workspace member access to a site, named by `email` or `memberId`.
-
- Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations.
-
+This creates access — it does not change an existing grant. A member who already has access to this site is refused with `member_already_has_access`; use `PATCH` to change their Site Role instead.
-Required scope | `CMS:read`
+This endpoint requires an Enterprise workspace.
+
+Required scope | `site_access:write`
@@ -6470,15 +14124,10 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.collections.items.list_items_live(
- collection_id="580e63fc8c9a982ac9b8b745",
- cms_locale_id="cmsLocaleId",
- offset=1,
- limit=1,
- name="name",
- slug="slug",
- sort_by="lastPublished",
- sort_order="asc",
+client.sites.members.add_member(
+ site_id="580e63e98c9a982ac9b8b741",
+ email="waylon.dalton@example.com",
+ site_role="designer",
)
```
@@ -6495,7 +14144,7 @@ client.collections.items.list_items_live(
-
-**collection_id:** `str` — Unique identifier for a Collection
+**site_id:** `str` — Unique identifier for a Site
@@ -6503,55 +14152,113 @@ client.collections.items.list_items_live(
-
-**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
+**site_role:** `GrantSiteMemberRequestBodySiteRole` — The Site Role to grant
+
+
+
+
+
+-
+
+**email:** `typing.Optional[str]` — Email address of the Workspace Member to grant access to. Provide either `email` or `memberId`, not both.
+
+
+
+
+
+-
+
+**member_id:** `typing.Optional[str]` — ID of the Workspace Member to grant access to. Provide either `email` or `memberId`, not both.
+
+
+
+
+
+-
+
+**site_role_id:** `typing.Optional[str]` — ID of the custom Site Role to grant. Required when `siteRole` is `custom`, and rejected with any other `siteRole`. Rejected if the id doesn't name a custom Site Role belonging to this workspace.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+client.sites.members.remove_member_by_email(...)
+
+-
+
+#### 📝 Description
-
-**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
-
-
-
-
-
-**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
-
+Remove a member's access to a site, identifying them by email address.
+
+Idempotent on a member who already holds no access to this site — nothing is revoked and this reports success. Not idempotent on someone who isn't a workspace member at all, which returns a `404`.
+
+Equivalent to [Revoke Site Access](/data/reference/enterprise/site-access/remove-member), which identifies the member by ID instead.
+
+This endpoint requires an Enterprise workspace.
+
+Required scope | `site_access:write`
+
+
+
+#### 🔌 Usage
-
-**name:** `typing.Optional[str]` — Filter by the exact name of the item(s)
-
-
-
-
-
-**slug:** `typing.Optional[str]` — Filter by the exact slug of the item
-
+```python
+from webflow import Webflow
+from webflow.environment import WebflowEnvironment
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.sites.members.remove_member_by_email(
+ site_id="580e63e98c9a982ac9b8b741",
+ email="email",
+)
+
+```
+
+
+
+#### ⚙️ Parameters
-
-**last_published:** `typing.Optional[ItemsListItemsLiveRequestLastPublished]` — Filter by the last published date of the item(s)
-
-
-
-
-
-**sort_by:** `typing.Optional[ItemsListItemsLiveRequestSortBy]` — Sort results by the provided value
+**site_id:** `str` — Unique identifier for a Site
@@ -6559,7 +14266,7 @@ client.collections.items.list_items_live(
-
-**sort_order:** `typing.Optional[ItemsListItemsLiveRequestSortOrder]` — Sorts the results by asc or desc
+**email:** `str` — Email address of the Site Member to revoke access from
@@ -6579,7 +14286,7 @@ client.collections.items.list_items_live(
client.collections.items.create_item_live(...) -> CollectionItem
+client.sites.members.update_member_role_by_email(...) -> SiteMember
-
@@ -6591,13 +14298,15 @@ client.collections.items.list_items_live(
-
-Create item(s) in a collection that will be immediately published to the live site.
+Update a site member's role, identifying them by email address.
+On a site with Site-specific access enabled, the member must already hold access to this site — grant it first with `POST`. On a site open to the whole workspace, this call sets a per-site role for the first time.
-To create items across multiple locales, [please use this endpoint.](/data/reference/cms/collection-items/staged-items/create-items)
+Equivalent to [Update Site Member Role](/data/reference/enterprise/site-access/update-member-role), which identifies the member by ID instead.
+This endpoint requires an Enterprise workspace.
-Required scope | `CMS:write`
+Required scope | `site_access:write`
@@ -6612,7 +14321,7 @@ Required scope | `CMS:write`
-
```python
-from webflow import Webflow, CollectionItem, CollectionItemFieldData
+from webflow import Webflow
from webflow.environment import WebflowEnvironment
client = Webflow(
@@ -6620,17 +14329,10 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.collections.items.create_item_live(
- collection_id="580e63fc8c9a982ac9b8b745",
- skip_invalid_files=True,
- request=CollectionItem(
- is_archived=False,
- is_draft=False,
- field_data=CollectionItemFieldData(
- name="The Hitchhiker\'s Guide to the Galaxy",
- slug="hitchhikers-guide-to-the-galaxy",
- ),
- ),
+client.sites.members.update_member_role_by_email(
+ site_id="580e63e98c9a982ac9b8b741",
+ email="email",
+ site_role="content_editor",
)
```
@@ -6647,7 +14349,7 @@ client.collections.items.create_item_live(
-
-**collection_id:** `str` — Unique identifier for a Collection
+**site_id:** `str` — Unique identifier for a Site
@@ -6655,7 +14357,7 @@ client.collections.items.create_item_live(
-
-**request:** `ItemsCreateItemLiveRequestBody`
+**email:** `str` — Email address of the Site Member whose role to change
@@ -6663,7 +14365,7 @@ client.collections.items.create_item_live(
-
-**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
+**request:** `UpdateSiteMemberRoleRequestBody`
@@ -6683,7 +14385,7 @@ client.collections.items.create_item_live(
client.collections.items.delete_items_live(...)
+client.sites.members.remove_member(...)
-
@@ -6695,11 +14397,15 @@ client.collections.items.create_item_live(
-
-Unpublish up to 100 items from the live site and set the `isDraft` property to `true`.
+Remove a member's access to a site.
-Items will only be unpublished in the primary locale unless a `cmsLocaleId` is included in the request.
+Idempotent on a member who already holds no access to this site — nothing is revoked and this reports success. Not idempotent on someone who isn't a workspace member at all, which returns a `404`.
-Required scope | `CMS:write`
+To revoke by email address instead of by ID, see [Revoke Site Access (by email)](/data/reference/enterprise/site-access/remove-member-by-email).
+
+This endpoint requires an Enterprise workspace.
+
+Required scope | `site_access:write`
@@ -6716,20 +14422,15 @@ Required scope | `CMS:write`
```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
-from webflow.collections.items import ItemsDeleteItemsLiveRequestItemsItem
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.collections.items.delete_items_live(
- collection_id="580e63fc8c9a982ac9b8b745",
- items=[
- ItemsDeleteItemsLiveRequestItemsItem(
- id="580e64008c9a982ac9b8b754",
- )
- ],
+client.sites.members.remove_member(
+ site_id="580e63e98c9a982ac9b8b741",
+ member_id="62fa5e47f6b8256f4641c5bd",
)
```
@@ -6746,7 +14447,7 @@ client.collections.items.delete_items_live(
-
-**collection_id:** `str` — Unique identifier for a Collection
+**site_id:** `str` — Unique identifier for a Site
@@ -6754,7 +14455,7 @@ client.collections.items.delete_items_live(
-
-**items:** `typing.List[ItemsDeleteItemsLiveRequestItemsItem]`
+**member_id:** `str` — Unique identifier for a Member
@@ -6774,7 +14475,7 @@ client.collections.items.delete_items_live(
client.collections.items.update_items_live(...) -> CollectionItemListNoPagination
+client.sites.members.update_member_role(...) -> SiteMember
-
@@ -6786,11 +14487,15 @@ client.collections.items.delete_items_live(
-
-Update a single published item or multiple published items (up to 100) in a Collection
+Update a site member's role.
-Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request.
+On a site with Site-specific access enabled, the member must already hold access to this site — grant it first with `POST`. On a site open to the whole workspace, this call sets a per-site role for the first time.
-Required scope | `CMS:write`
+To update by email address instead of by ID, see [Update Site Member Role (by email)](/data/reference/enterprise/site-access/update-member-role-by-email).
+
+This endpoint requires an Enterprise workspace.
+
+Required scope | `site_access:write`
@@ -6805,7 +14510,7 @@ Required scope | `CMS:write`
-
```python
-from webflow import Webflow, CollectionItemWithIdInput, CollectionItemWithIdInputFieldData
+from webflow import Webflow
from webflow.environment import WebflowEnvironment
client = Webflow(
@@ -6813,43 +14518,10 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.collections.items.update_items_live(
- collection_id="580e63fc8c9a982ac9b8b745",
- skip_invalid_files=True,
- items=[
- CollectionItemWithIdInput(
- id="66f6ed9576ddacf3149d5ea6",
- cms_locale_id="66f6e966c9e1dc700a857ca5",
- field_data=CollectionItemWithIdInputFieldData(
- name="Ne Paniquez Pas",
- slug="ne-paniquez-pas",
- ),
- ),
- CollectionItemWithIdInput(
- id="66f6ed9576ddacf3149d5ea6",
- cms_locale_id="66f6e966c9e1dc700a857ca4",
- field_data=CollectionItemWithIdInputFieldData(
- name="No Entrar en Pánico",
- slug="no-entrar-en-panico",
- ),
- ),
- CollectionItemWithIdInput(
- id="66f6ed9576ddacf3149d5eaa",
- cms_locale_id="66f6e966c9e1dc700a857ca5",
- field_data=CollectionItemWithIdInputFieldData(
- name="Au Revoir et Merci pour Tous les Poissons",
- slug="au-revoir-et-merci",
- ),
- ),
- CollectionItemWithIdInput(
- id="66f6ed9576ddacf3149d5eaa",
- cms_locale_id="66f6e966c9e1dc700a857ca4",
- field_data=CollectionItemWithIdInputFieldData(
- name="Hasta Luego y Gracias por Todo el Pescado",
- slug="hasta-luego-y-gracias",
- ),
- )
- ],
+client.sites.members.update_member_role(
+ site_id="580e63e98c9a982ac9b8b741",
+ member_id="62fa5e47f6b8256f4641c5bd",
+ site_role="content_editor",
)
```
@@ -6866,7 +14538,7 @@ client.collections.items.update_items_live(
-
-**collection_id:** `str` — Unique identifier for a Collection
+**site_id:** `str` — Unique identifier for a Site
@@ -6874,7 +14546,7 @@ client.collections.items.update_items_live(
-
-**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
+**member_id:** `str` — Unique identifier for a Member
@@ -6882,7 +14554,7 @@ client.collections.items.update_items_live(
-
-**items:** `typing.Optional[typing.List[CollectionItemWithIdInput]]`
+**request:** `UpdateSiteMemberRoleRequestBody`
@@ -6902,7 +14574,8 @@ client.collections.items.update_items_live(
client.collections.items.create_items(...) -> BulkCollectionItem
+## Sites ActivityLogs
+client.sites.activity_logs.list(...) -> SiteActivityLogResponse
-
@@ -6914,14 +14587,11 @@ client.collections.items.update_items_live(
-
-Create an item or multiple items in a CMS Collection across multiple corresponding locales.
+Retrieve Activity Logs for a specific Site.
-
- - This endpoint can create up to 100 items in a request.
- - If the `cmsLocaleIds` parameter is not included in the request, an item will only be created in the primary locale.
-
+This endpoint requires an Enterprise workspace.
-Required scope | `CMS:write`
+Required scope: `site_activity:read`
@@ -6938,27 +14608,16 @@ Required scope | `CMS:write`
```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
-from webflow.collections.items import SingleCmsItem
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.collections.items.create_items(
- collection_id="580e63fc8c9a982ac9b8b745",
- skip_invalid_files=True,
- cms_locale_ids=[
- "66f6e966c9e1dc700a857ca3",
- "66f6e966c9e1dc700a857ca4",
- "66f6e966c9e1dc700a857ca5"
- ],
- is_archived=False,
- is_draft=False,
- field_data=SingleCmsItem(
- name="Don’t Panic",
- slug="dont-panic",
- ),
+client.sites.activity_logs.list(
+ site_id="580e63e98c9a982ac9b8b741",
+ limit=1,
+ offset=1,
)
```
@@ -6975,31 +14634,7 @@ client.collections.items.create_items(
-
-**collection_id:** `str` — Unique identifier for a Collection
-
-
-
-
-
--
-
-**field_data:** `CreateBulkCollectionItemRequestBodyFieldData`
-
-
-
-
-
--
-
-**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
-
-
-
-
-
--
-
-**cms_locale_ids:** `typing.Optional[typing.List[str]]` — Array of identifiers for the locales where the item will be created
+**site_id:** `str` — Unique identifier for a Site
@@ -7007,7 +14642,7 @@ client.collections.items.create_items(
-
-**is_archived:** `typing.Optional[bool]` — Indicates whether the item is archived.
+**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
@@ -7015,7 +14650,7 @@ client.collections.items.create_items(
-
-**is_draft:** `typing.Optional[bool]` — Indicates whether the item is in draft state.
+**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
@@ -7035,7 +14670,8 @@ client.collections.items.create_items(
client.collections.items.get_item(...) -> CollectionItem
+## Sites Comments
+client.sites.comments.list_comment_threads(...) -> CommentThreadList
-
@@ -7047,9 +14683,13 @@ client.collections.items.create_items(
-
-Get details of a selected Collection Item.
+List all comment threads for a site.
-Required scope | `CMS:read`
+
+ There may be a delay of up to 5 minutes before new comments appear in the system.
+
+
+Required scope | `comments:read`
@@ -7072,10 +14712,13 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.collections.items.get_item(
- collection_id="580e63fc8c9a982ac9b8b745",
- item_id="580e64008c9a982ac9b8b754",
- cms_locale_id="cmsLocaleId",
+client.sites.comments.list_comment_threads(
+ site_id="580e63e98c9a982ac9b8b741",
+ locale_id="65427cf400e02b306eaa04a0",
+ offset=1,
+ limit=1,
+ sort_by="createdOn",
+ sort_order="asc",
)
```
@@ -7092,7 +14735,7 @@ client.collections.items.get_item(
-
-**collection_id:** `str` — Unique identifier for a Collection
+**site_id:** `str` — Unique identifier for a Site
@@ -7100,7 +14743,11 @@ client.collections.items.get_item(
-
-**item_id:** `str` — Unique identifier for an Item
+**locale_id:** `typing.Optional[str]`
+
+Unique identifier for a specific Locale.
+
+[Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
@@ -7108,7 +14755,31 @@ client.collections.items.get_item(
-
-**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
+**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
+
+
+
+
+
+-
+
+**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+
+
+
+
+
+-
+
+**sort_by:** `typing.Optional[CommentsListCommentThreadsRequestSortBy]` — Sort results by the provided value. Only allowed when sortOrder is provided.
+
+
+
+
+
+-
+
+**sort_order:** `typing.Optional[CommentsListCommentThreadsRequestSortOrder]` — Sorts the results by asc or desc
@@ -7128,7 +14799,7 @@ client.collections.items.get_item(
client.collections.items.delete_item(...)
+client.sites.comments.get_comment_thread(...) -> CommentThread
-
@@ -7140,9 +14811,13 @@ client.collections.items.get_item(
-
-Delete an item from a collection.
+Get details of a specific comment thread.
-Required scope | `CMS:write`
+
+ There may be a delay of up to 5 minutes before new comments appear in the system.
+
+
+Required scope | `comments:read`
@@ -7165,10 +14840,14 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.collections.items.delete_item(
- collection_id="580e63fc8c9a982ac9b8b745",
- item_id="580e64008c9a982ac9b8b754",
- cms_locale_id="cmsLocaleId",
+client.sites.comments.get_comment_thread(
+ site_id="580e63e98c9a982ac9b8b741",
+ comment_thread_id="580e63e98c9a982ac9b8b741",
+ locale_id="65427cf400e02b306eaa04a0",
+ offset=1,
+ limit=1,
+ sort_by="createdOn",
+ sort_order="asc",
)
```
@@ -7185,7 +14864,7 @@ client.collections.items.delete_item(
-
-**collection_id:** `str` — Unique identifier for a Collection
+**site_id:** `str` — Unique identifier for a Site
@@ -7193,7 +14872,7 @@ client.collections.items.delete_item(
-
-**item_id:** `str` — Unique identifier for an Item
+**comment_thread_id:** `str` — Unique identifier for a Comment Thread
@@ -7201,7 +14880,43 @@ client.collections.items.delete_item(
-
-**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
+**locale_id:** `typing.Optional[str]`
+
+Unique identifier for a specific Locale.
+
+[Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
+
+
+
+
+-
+
+**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
+
+
+
+
+
+-
+
+**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+
+
+
+
+
+-
+
+**sort_by:** `typing.Optional[CommentsGetCommentThreadRequestSortBy]` — Sort results by the provided value. Only allowed when sortOrder is provided.
+
+
+
+
+
+-
+
+**sort_order:** `typing.Optional[CommentsGetCommentThreadRequestSortOrder]` — Sorts the results by asc or desc
@@ -7221,7 +14936,7 @@ client.collections.items.delete_item(
client.collections.items.update_item(...) -> CollectionItem
+client.sites.comments.resolve_comment_thread(...) -> CommentThread
-
@@ -7233,9 +14948,13 @@ client.collections.items.delete_item(
-
-Update a selected Item in a Collection.
+Resolve or unresolve a comment thread.
-Required scope | `CMS:write`
+
+ This endpoint is rate limited to 60 requests per minute per site.
+
+
+Required scope | `comments:write`
@@ -7250,7 +14969,7 @@ Required scope | `CMS:write`
-
```python
-from webflow import Webflow, CollectionItemPatchSingleFieldData
+from webflow import Webflow
from webflow.environment import WebflowEnvironment
client = Webflow(
@@ -7258,16 +14977,10 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.collections.items.update_item(
- collection_id="580e63fc8c9a982ac9b8b745",
- item_id="580e64008c9a982ac9b8b754",
- skip_invalid_files=True,
- is_archived=False,
- is_draft=False,
- field_data=CollectionItemPatchSingleFieldData(
- name="The Hitchhiker\'s Guide to the Galaxy",
- slug="hitchhikers-guide-to-the-galaxy",
- ),
+client.sites.comments.resolve_comment_thread(
+ site_id="580e63e98c9a982ac9b8b741",
+ comment_thread_id="580e63e98c9a982ac9b8b741",
+ resolved=True,
)
```
@@ -7284,15 +14997,7 @@ client.collections.items.update_item(
-
-**collection_id:** `str` — Unique identifier for a Collection
-
-
-
-
-
--
-
-**item_id:** `str` — Unique identifier for an Item
+**site_id:** `str` — Unique identifier for a Site
@@ -7300,7 +15005,7 @@ client.collections.items.update_item(
-
-**request:** `CollectionItemPatchSingle`
+**comment_thread_id:** `str` — Unique identifier for a Comment Thread
@@ -7308,7 +15013,7 @@ client.collections.items.update_item(
-
-**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
+**resolved:** `bool` — Set to `true` to resolve the thread, or `false` to unresolve it
@@ -7328,7 +15033,7 @@ client.collections.items.update_item(
client.collections.items.get_item_live(...) -> CollectionItem
+client.sites.comments.list_comment_replies(...) -> CommentReplyList
-
@@ -7340,13 +15045,13 @@ client.collections.items.update_item(
-
-Get details of a selected Collection live Item.
+List all replies to a specific comment thread.
-
- Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations.
-
+
+ There may be a delay of up to 5 minutes before new comments appear in the system.
+
-Required scope | `CMS:read`
+Required scope | `comments:read`
@@ -7369,10 +15074,14 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.collections.items.get_item_live(
- collection_id="580e63fc8c9a982ac9b8b745",
- item_id="580e64008c9a982ac9b8b754",
- cms_locale_id="cmsLocaleId",
+client.sites.comments.list_comment_replies(
+ site_id="580e63e98c9a982ac9b8b741",
+ comment_thread_id="580e63e98c9a982ac9b8b741",
+ locale_id="65427cf400e02b306eaa04a0",
+ offset=1,
+ limit=1,
+ sort_by="createdOn",
+ sort_order="asc",
)
```
@@ -7389,7 +15098,7 @@ client.collections.items.get_item_live(
-
-**collection_id:** `str` — Unique identifier for a Collection
+**site_id:** `str` — Unique identifier for a Site
@@ -7397,7 +15106,7 @@ client.collections.items.get_item_live(
-
-**item_id:** `str` — Unique identifier for an Item
+**comment_thread_id:** `str` — Unique identifier for a Comment Thread
@@ -7405,7 +15114,43 @@ client.collections.items.get_item_live(
-
-**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
+**locale_id:** `typing.Optional[str]`
+
+Unique identifier for a specific Locale.
+
+[Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
+
+
+
+
+-
+
+**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
+
+
+
+
+
+-
+
+**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+
+
+
+
+
+-
+
+**sort_by:** `typing.Optional[CommentsListCommentRepliesRequestSortBy]` — Sort results by the provided value. Only allowed when sortOrder is provided.
+
+
+
+
+
+-
+
+**sort_order:** `typing.Optional[CommentsListCommentRepliesRequestSortOrder]` — Sorts the results by asc or desc
@@ -7425,7 +15170,7 @@ client.collections.items.get_item_live(
client.collections.items.delete_item_live(...)
+client.sites.comments.create_comment_reply(...) -> CommentReply
-
@@ -7437,11 +15182,16 @@ client.collections.items.get_item_live(
-
-Unpublish a live item from the site and set the `isDraft` property to `true`.
+Create a reply to an existing comment thread.
-For bulk unpublishing, please use [this endpoint.](/data/v2.0.0/reference/cms/collection-items/live-items/delete-items-live)
+The reply author is always the user who authorized the OAuth token.
+To @mention a user in the reply, include their user ID in double square brackets in the `content` field, as in `[[userId]]`.
-Required scope | `CMS:write`
+
+ The `comment_created` webhook fires automatically when a reply is created.
+
+
+Required scope | `comments:write`
@@ -7464,10 +15214,10 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.collections.items.delete_item_live(
- collection_id="580e63fc8c9a982ac9b8b745",
- item_id="580e64008c9a982ac9b8b754",
- cms_locale_id="cmsLocaleId",
+client.sites.comments.create_comment_reply(
+ site_id="580e63e98c9a982ac9b8b741",
+ comment_thread_id="580e63e98c9a982ac9b8b741",
+ content="Thanks for the feedback [[6287ec36a841b25637c663df]]!",
)
```
@@ -7484,7 +15234,7 @@ client.collections.items.delete_item_live(
-
-**collection_id:** `str` — Unique identifier for a Collection
+**site_id:** `str` — Unique identifier for a Site
@@ -7492,7 +15242,7 @@ client.collections.items.delete_item_live(
-
-**item_id:** `str` — Unique identifier for an Item
+**comment_thread_id:** `str` — Unique identifier for a Comment Thread
@@ -7500,7 +15250,7 @@ client.collections.items.delete_item_live(
-
-**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
+**content:** `str` — The text content of the reply. To @mention a user, include their user ID in double square brackets, as in `[[userId]]`.
@@ -7520,7 +15270,8 @@ client.collections.items.delete_item_live(
client.collections.items.update_item_live(...) -> CollectionItem
+## Sites Scripts
+client.sites.scripts.get_custom_code(...) -> ScriptApplyList
-
@@ -7532,9 +15283,15 @@ client.collections.items.delete_item_live(
-
-Update a selected live Item in a Collection. The updates for this Item will be published to the live site.
+Get all scripts applied to a site by the App.
-Required scope | `CMS:write`
+
+ To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
+
+
+Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).
+
+Required scope | `custom_code:read`
@@ -7549,7 +15306,7 @@ Required scope | `CMS:write`
-
```python
-from webflow import Webflow, CollectionItemPatchSingleFieldData
+from webflow import Webflow
from webflow.environment import WebflowEnvironment
client = Webflow(
@@ -7557,16 +15314,8 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.collections.items.update_item_live(
- collection_id="580e63fc8c9a982ac9b8b745",
- item_id="580e64008c9a982ac9b8b754",
- skip_invalid_files=True,
- is_archived=False,
- is_draft=False,
- field_data=CollectionItemPatchSingleFieldData(
- name="The Hitchhiker\'s Guide to the Galaxy",
- slug="hitchhikers-guide-to-the-galaxy",
- ),
+client.sites.scripts.get_custom_code(
+ site_id="580e63e98c9a982ac9b8b741",
)
```
@@ -7583,31 +15332,7 @@ client.collections.items.update_item_live(
-
-**collection_id:** `str` — Unique identifier for a Collection
-
-
-
-
-
--
-
-**item_id:** `str` — Unique identifier for an Item
-
-
-
-
-
--
-
-**request:** `CollectionItemPatchSingle`
-
-
-
-
-
--
-
-**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
+**site_id:** `str` — Unique identifier for a Site
@@ -7627,7 +15352,7 @@ client.collections.items.update_item_live(
client.collections.items.publish_item(...) -> ItemsPublishItemResponse
+client.sites.scripts.upsert_custom_code(...) -> ScriptApplyList
-
@@ -7639,9 +15364,15 @@ client.collections.items.update_item_live(
-
-Publish an item or multiple items.
+Apply registered scripts to a site. If you have multiple scripts your App needs to apply or maintain on a site, ensure they are always included in the request body for this endpoint. To remove individual scripts, simply call this endpoint without the script in the request body.
-Required scope | `cms:write`
+
+ To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
+
+
+Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).
+
+Required scope | `custom_code:write`
@@ -7656,24 +15387,31 @@ Required scope | `cms:write`
-
```python
-from webflow import Webflow
+from webflow import Webflow, ScriptApply
from webflow.environment import WebflowEnvironment
-from webflow.collections.items import ItemIDs
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.collections.items.publish_item(
- collection_id="580e63fc8c9a982ac9b8b745",
- request=ItemIDs(
- item_ids=[
- "643fd856d66b6528195ee2ca",
- "643fd856d66b6528195ee2cb",
- "643fd856d66b6528195ee2cc"
- ],
- ),
+client.sites.scripts.upsert_custom_code(
+ site_id="580e63e98c9a982ac9b8b741",
+ scripts=[
+ ScriptApply(
+ id="cms_slider",
+ location="header",
+ version="1.0.0",
+ attributes={
+ "my-attribute": "some-value"
+ },
+ ),
+ ScriptApply(
+ id="alert",
+ location="header",
+ version="0.0.1",
+ )
+ ],
)
```
@@ -7690,7 +15428,7 @@ client.collections.items.publish_item(
-
-**collection_id:** `str` — Unique identifier for a Collection
+**site_id:** `str` — Unique identifier for a Site
@@ -7698,7 +15436,7 @@ client.collections.items.publish_item(
-
-**request:** `ItemsPublishItemRequest`
+**request:** `ScriptApplyList`
@@ -7718,8 +15456,7 @@ client.collections.items.publish_item(
client.pages.scripts.get_custom_code(...) -> ScriptApplyList
+client.sites.scripts.delete_custom_code(...)
-
@@ -7731,9 +15468,13 @@ client.collections.items.publish_item(
-
-Get all scripts applied to a page.
+Remove all scripts from a site applied by the App. This endpoint will not remove scripts from the site's registered scripts.
-Required scope | `custom_code:read`
+To remove individual scripts applied by the App, use the [Add/Update Custom Code](/data/reference/custom-code/custom-code-sites/upsert-custom-code) endpoint.
+
+Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).
+
+Required scope | `custom_code:write`
@@ -7756,8 +15497,8 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.pages.scripts.get_custom_code(
- page_id="63c720f9347c2139b248e552",
+client.sites.scripts.delete_custom_code(
+ site_id="580e63e98c9a982ac9b8b741",
)
```
@@ -7774,7 +15515,7 @@ client.pages.scripts.get_custom_code(
-
-**page_id:** `str` — Unique identifier for a Page
+**site_id:** `str` — Unique identifier for a Site
@@ -7794,7 +15535,7 @@ client.pages.scripts.get_custom_code(
client.pages.scripts.upsert_custom_code(...) -> ScriptApplyList
+client.sites.scripts.list_custom_code_blocks(...) -> ListCustomCodeBlocks
-
@@ -7806,13 +15547,17 @@ client.pages.scripts.get_custom_code(
-
-Apply registered scripts to a page. If you have multiple scripts your App needs to apply or maintain on a page, ensure they are always included in the request body for this endpoint. To remove individual scripts, simply call this endpoint without the script in the request body.
+Get a list of scripts that have been applied to a site and/or individual pages.
- To apply a script to a page, the script must first be registered to a Site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
+ To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints.
+
+ See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
-Required scope | `custom_code:write`
+Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).
+
+Required scope | `custom_code:read`
@@ -7827,7 +15572,7 @@ Required scope | `custom_code:write`
-
```python
-from webflow import Webflow, ScriptApply
+from webflow import Webflow
from webflow.environment import WebflowEnvironment
client = Webflow(
@@ -7835,23 +15580,10 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.pages.scripts.upsert_custom_code(
- page_id="63c720f9347c2139b248e552",
- scripts=[
- ScriptApply(
- id="cms_slider",
- location="header",
- version="1.0.0",
- attributes={
- "my-attribute": "some-value"
- },
- ),
- ScriptApply(
- id="alert",
- location="header",
- version="0.0.1",
- )
- ],
+client.sites.scripts.list_custom_code_blocks(
+ site_id="580e63e98c9a982ac9b8b741",
+ offset=1,
+ limit=1,
)
```
@@ -7868,7 +15600,7 @@ client.pages.scripts.upsert_custom_code(
-
-**page_id:** `str` — Unique identifier for a Page
+**site_id:** `str` — Unique identifier for a Site
@@ -7876,7 +15608,15 @@ client.pages.scripts.upsert_custom_code(
-
-**request:** `ScriptApplyList`
+**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
+
+
+
+
+
+-
+
+**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
@@ -7896,7 +15636,8 @@ client.pages.scripts.upsert_custom_code(
client.pages.scripts.delete_custom_code(...)
+## Sites Forms
+client.sites.forms.list_submissions_by_site(...) -> FormSubmissionList
-
@@ -7908,13 +15649,17 @@ client.pages.scripts.upsert_custom_code(
-
-Remove all scripts from a page applied by the App. This endpoint will not remove scripts from the site's registered scripts.
+List all form submissions for a given site with the ability to filter submissions by a centralized `elementId`.
-To remove individual scripts applied by the App, use the [Add/Update Custom Code](/data/reference/custom-code/custom-code-pages/upsert-custom-code) endpoint.
+Add `elementId` when you want to filter form submissions to a specific form in a site. You can get the `elementId` from the [List forms endpoint](/data/reference/forms/forms/list) (displayed as `formElementId` in the response).
-Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).
+
+When a form is used in a Webflow component definition, each instance of the component will yield a unique form. Adding the `elementId` in this request ensures this API response includes all submissions from that core form, wherever that form is used in instantiated components.
+
-Required scope | `custom_code:write`
+Use the [List Form Submissions endpoint](/data/reference/forms/form-submissions/list-submissions) to list form submissions for a given form ID.
+
+Required scope | `forms:read`
@@ -7937,8 +15682,11 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.pages.scripts.delete_custom_code(
- page_id="63c720f9347c2139b248e552",
+client.sites.forms.list_submissions_by_site(
+ site_id="580e63e98c9a982ac9b8b741",
+ element_id="18259716-3e5a-646a-5f41-5dc4b9405aa0",
+ offset=1,
+ limit=1,
)
```
@@ -7955,7 +15703,31 @@ client.pages.scripts.delete_custom_code(
-
-**page_id:** `str` — Unique identifier for a Page
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**element_id:** `typing.Optional[str]` — Identifier for an element
+
+
+
+
+
+-
+
+**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
+
+
+
+
+
+-
+
+**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
@@ -7975,8 +15747,7 @@ client.pages.scripts.delete_custom_code(
client.sites.redirects.list(...) -> Redirects
+client.sites.forms.list_submissions(...) -> FormSubmissionList
-
@@ -7988,13 +15759,11 @@ client.pages.scripts.delete_custom_code(
-
-Fetch a list of all 301 redirect rules configured for a specific site.
-
-Use this endpoint to review, audit, or manage the redirection rules that control how traffic is rerouted on your site.
+List form submissions for a given form ID within a specific site.
-This endpoint requires an Enterprise workspace.
+Use the [List Form Submissions by Site endpoint](/data/reference/forms/form-submissions/list-submissions-by-site) to list form submissions for a given site with the ability to filter by a `formElementId`.
-Required scope: `sites:read`
+Required scope | `forms:read`
@@ -8017,8 +15786,11 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.sites.redirects.list(
+client.sites.forms.list_submissions(
site_id="580e63e98c9a982ac9b8b741",
+ form_id="580e63e98c9a982ac9b8b741",
+ offset=1,
+ limit=1,
)
```
@@ -8043,6 +15815,30 @@ client.sites.redirects.list(
-
+**form_id:** `str` — Unique identifier for a Form
+
+
+
+
+
+-
+
+**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
+
+
+
+
+
+-
+
+**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -8055,7 +15851,7 @@ client.sites.redirects.list(
client.sites.redirects.create(...) -> Redirect
+client.sites.forms.get_submission(...) -> FormSubmission
-
@@ -8067,13 +15863,9 @@ client.sites.redirects.list(
-
-Add a new 301 redirection rule to a site.
-
-This endpoint allows you to define a source path (`fromUrl`) and its corresponding destination path (`toUrl`), which will dictate how traffic is rerouted on your site. This is useful for managing site changes, restructuring URLs, or handling outdated links.
-
-This endpoint requires an Enterprise workspace.
+Get information about a form submission within a specific site.
-Required scope: `sites:write`
+Required scope | `forms:read`
@@ -8096,11 +15888,9 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.sites.redirects.create(
+client.sites.forms.get_submission(
site_id="580e63e98c9a982ac9b8b741",
- id="42e1a2b7aa1a13f768a0042a",
- from_url="/mostly-harmless",
- to_url="/earth",
+ form_submission_id="580e63e98c9a982ac9b8b741",
)
```
@@ -8125,7 +15915,7 @@ client.sites.redirects.create(
-
-**request:** `Redirect`
+**form_submission_id:** `str` — Unique identifier for a Form Submission
@@ -8145,7 +15935,7 @@ client.sites.redirects.create(
client.sites.redirects.delete(...) -> Redirects
+client.sites.forms.delete_submission(...)
-
@@ -8157,13 +15947,9 @@ client.sites.redirects.create(
-
-Remove a 301 redirection rule from a site.
-
-This is useful for cleaning up outdated or unnecessary redirects, ensuring that your site's routing behavior remains efficient and up-to-date.
-
-This endpoint requires an Enterprise workspace.
+Delete a form submission within a specific site.
-Required scope: `sites:write`
+Required scope | `forms:write`
@@ -8186,9 +15972,9 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.sites.redirects.delete(
+client.sites.forms.delete_submission(
site_id="580e63e98c9a982ac9b8b741",
- redirect_id="66c4cb9a20cac35ed19500e6",
+ form_submission_id="580e63e98c9a982ac9b8b741",
)
```
@@ -8213,7 +15999,7 @@ client.sites.redirects.delete(
-
-**redirect_id:** `str` — Unique identifier site redirect
+**form_submission_id:** `str` — Unique identifier for a Form Submission
@@ -8233,7 +16019,7 @@ client.sites.redirects.delete(
client.sites.redirects.update(...) -> Redirect
+client.sites.forms.update_submission(...) -> FormSubmission
-
@@ -8245,11 +16031,9 @@ client.sites.redirects.delete(
-
-Update a 301 redirection rule from a site.
-
-This endpoint requires an Enterprise workspace.
+Update hidden fields on a form submission within a specific site.
-Required scope: `sites:write`
+Required scope | `forms:write`
@@ -8272,12 +16056,9 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.sites.redirects.update(
+client.sites.forms.update_submission(
site_id="580e63e98c9a982ac9b8b741",
- redirect_id="66c4cb9a20cac35ed19500e6",
- id="42e1a2b7aa1a13f768a0042a",
- from_url="/mostly-harmless",
- to_url="/earth",
+ form_submission_id="580e63e98c9a982ac9b8b741",
)
```
@@ -8302,7 +16083,7 @@ client.sites.redirects.update(
-
-**redirect_id:** `str` — Unique identifier site redirect
+**form_submission_id:** `str` — Unique identifier for a Form Submission
@@ -8310,7 +16091,7 @@ client.sites.redirects.update(
-
-**request:** `Redirect`
+**form_submission_data:** `typing.Optional[typing.Dict[str, typing.Any]]` — An existing **hidden field** defined on the form schema, and the corresponding value to set
@@ -8330,8 +16111,8 @@ client.sites.redirects.update(
client.sites.plans.get_site_plan(...) -> SitePlan
+## Sites Aeo Reports
+client.sites.aeo.reports.bot_traffic(...) -> AeoBotTrafficResponse
-
@@ -8343,9 +16124,13 @@ client.sites.redirects.update(
-
-Get site plan details for the specified Site.
+Returns the total number of requests made to the site by the AI bots Webflow tracks, over a time range. This counts bot requests, not visitors or page views. For visitor traffic, use the [Analyze API](/data/docs/working-with-analyze). Filter by bot provider or bot category.
-This endpoint requires an Enterprise workspace.
+Counts successful requests (HTTP `200` or `304`). Bot providers combine with OR, and `botCategory` narrows them further.
+
+This endpoint requires a site or workspace with the AEO analytics entitlement.
+
+Each access token can have one AEO request in flight at a time, across all AEO Analytics endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
Required scope | `sites:read`
@@ -8364,31 +16149,70 @@ Required scope | `sites:read`
```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
+import datetime
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.sites.plans.get_site_plan(
+client.sites.aeo.reports.bot_traffic(
site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat("2026-09-01T00:00:00+00:00"),
+ end_time=datetime.datetime.fromisoformat("2026-09-08T00:00:00+00:00"),
+ bot_providers=[
+ "openai"
+ ],
+ bot_category="agent",
)
-```
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**site_id:** `str` — Unique identifier for a Site
+
+
+
+
+
+-
+
+**start_time:** `datetime.datetime` — Inclusive start of the time range. Must be a UTC timestamp ending in `Z`, such as `2026-09-01T00:00:00Z`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional.
+
+
+
+-
+
+**end_time:** `datetime.datetime` — Exclusive end of the time range. Must be a UTC timestamp ending in `Z`, and later than `startTime`. The range can be at most 100 days. Can't be later than the start of the current UTC day, because today's data isn't available yet.
+
-#### ⚙️ Parameters
-
-
+**bot_providers:** `typing.Optional[typing.Union[AeoBotProvider, typing.Sequence[AeoBotProvider]]]` — Count only bots from these providers. Repeat the parameter for more than one, such as `botProviders=openai&botProviders=anthropic`. Comma-separated values aren't accepted.
+
+
+
+
-
-**site_id:** `str` — Unique identifier for a Site
+**bot_category:** `typing.Optional[AeoBotCategory]` — Count only bots in this category.
@@ -8408,8 +16232,7 @@ client.sites.plans.get_site_plan(
client.sites.robots_txt.get(...) -> Robots
+client.sites.aeo.reports.bot_traffic_pages(...) -> AeoBotTrafficPagesResponse
-
@@ -8421,11 +16244,15 @@ client.sites.plans.get_site_plan(
-
-Retrieve the robots.txt configuration for various user agents.
+Returns the pages and files that the AI bots Webflow tracks requested most over a time range, with each one's request count.
-This endpoint requires an Enterprise workspace.
+Results are sorted by `requestCount`, highest first, and aren't paginated. Each row is one combination of page, CMS item, and request path, so a page can appear more than once.
-Required scope: `site_config:read`
+This endpoint requires a site or workspace with the AEO analytics entitlement.
+
+Each access token can have one AEO request in flight at a time, across all AEO Analytics endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
@@ -8442,14 +16269,22 @@ Required scope: `site_config:read`
```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
+import datetime
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.sites.robots_txt.get(
+client.sites.aeo.reports.bot_traffic_pages(
site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat("2026-09-01T00:00:00+00:00"),
+ end_time=datetime.datetime.fromisoformat("2026-09-08T00:00:00+00:00"),
+ bot_providers=[
+ "openai"
+ ],
+ bot_category="agent",
+ limit=1,
)
```
@@ -8474,6 +16309,46 @@ client.sites.robots_txt.get(
-
+**start_time:** `datetime.datetime` — Inclusive start of the time range. Must be a UTC timestamp ending in `Z`, such as `2026-09-01T00:00:00Z`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional.
+
+
+
+
+
+-
+
+**end_time:** `datetime.datetime` — Exclusive end of the time range. Must be a UTC timestamp ending in `Z`, and later than `startTime`. The range can be at most 100 days. Can't be later than the start of the current UTC day, because today's data isn't available yet.
+
+
+
+
+
+-
+
+**bot_providers:** `typing.Optional[typing.Union[AeoBotProvider, typing.Sequence[AeoBotProvider]]]` — Count only bots from these providers. Repeat the parameter for more than one, such as `botProviders=openai&botProviders=anthropic`. Comma-separated values aren't accepted.
+
+
+
+
+
+-
+
+**bot_category:** `typing.Optional[AeoBotCategory]` — Count only bots in this category.
+
+
+
+
+
+-
+
+**limit:** `typing.Optional[int]` — Maximum number of rows to return. Defaults to `100`, which is also the maximum.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -8486,7 +16361,7 @@ client.sites.robots_txt.get(
client.sites.robots_txt.put(...) -> Robots
+client.sites.aeo.reports.visibility(...) -> AeoVisibilityResponse
-
@@ -8498,11 +16373,15 @@ client.sites.robots_txt.get(
-
-Replace the `robots.txt` configuration for various user agents.
+Returns the share of answer engine responses that mention your organization, for a time range or as a daily or weekly series.
-This endpoint requires an Enterprise workspace.
+Without `timeseries`, returns one score for the whole time range. With `timeseries`, returns one score per day or week. Separate filters combine with AND, and values within one filter combine with OR. Requires an organization name in the site's Organization info.
-Required scope | `site_config:write`
+This endpoint requires a site or workspace with the AEO analytics entitlement, and Webflow AI must be enabled for the workspace.
+
+Each access token can have one AEO request in flight at a time, across all AEO Analytics endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
@@ -8517,29 +16396,26 @@ Required scope | `site_config:write`
-
```python
-from webflow import Webflow, RobotsRulesItem
+from webflow import Webflow
from webflow.environment import WebflowEnvironment
+import datetime
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.sites.robots_txt.put(
+client.sites.aeo.reports.visibility(
site_id="580e63e98c9a982ac9b8b741",
- rules=[
- RobotsRulesItem(
- user_agent="googlebot",
- allows=[
- "/public"
- ],
- disallows=[
- "/vogon-poetry",
- "/total-perspective-vortex"
- ],
- )
+ start_time=datetime.datetime.fromisoformat("2026-09-01T00:00:00+00:00"),
+ end_time=datetime.datetime.fromisoformat("2026-09-08T00:00:00+00:00"),
+ topic_ids=[
+ "68cdb4b5a699862fcd8c1a02"
],
- sitemap="https://heartofgold.ship/sitemap.xml",
+ prompt_ids=[
+ "68cdb4b5a699862fcd8c1a01"
+ ],
+ answer_engine="chat-gpt",
)
```
@@ -8564,7 +16440,47 @@ client.sites.robots_txt.put(
-
-**request:** `Robots`
+**start_time:** `datetime.datetime` — Inclusive start of the time range. Must be a UTC timestamp ending in `Z`, such as `2026-09-01T00:00:00Z`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional.
+
+
+
+
+
+-
+
+**end_time:** `datetime.datetime` — Exclusive end of the time range. Must be a UTC timestamp ending in `Z`, and later than `startTime`. The range can be at most 100 days.
+
+
+
+
+
+-
+
+**topic_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Include only these topics. Get topic IDs from [List Prompts](/data/reference/aeo-analytics/list-prompts). Repeat the parameter for more than one, up to 50.
+
+
+
+
+
+-
+
+**prompt_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Include only these prompts. Get prompt IDs from [List Prompts](/data/reference/aeo-analytics/list-prompts). Repeat the parameter for more than one, up to 50.
+
+
+
+
+
+-
+
+**answer_engine:** `typing.Optional[AeoAnswerEngineKey]` — Include only responses from this answer engine.
+
+
+
+
+
+-
+
+**timeseries:** `typing.Optional[AeoTimeseries]` — Return one score per day or week. Send both fields in bracket notation, such as `timeseries[granularityPeriod]=day×eries[bucketTimeZone]=America/New_York`.
@@ -8584,7 +16500,7 @@ client.sites.robots_txt.put(
client.sites.robots_txt.delete(...) -> Robots
+client.sites.aeo.reports.visibility_breakdown(...) -> AeoVisibilityBreakdownResponse
-
@@ -8596,13 +16512,15 @@ client.sites.robots_txt.put(
-
-Remove specific rules for a user-agent in your `robots.txt` file. To delete all rules for a user-agent, provide an empty rule set. This will remove the user-agent's entry entirely, leaving it subject to your site's default crawling behavior.
+Returns the visibility score for each topic or prompt over a time range, highest first.
-**Note:** Deleting a user-agent with no rules will make the user-agent's access unrestricted unless other directives apply.
+Choose `breakdown=topic` or `breakdown=prompt`. A topic or prompt appears only if it has responses in the time range. Separate filters combine with AND, and values within one filter combine with OR. Requires an organization name in the site's Organization info.
-This endpoint requires an Enterprise workspace.
+This endpoint requires a site or workspace with the AEO analytics entitlement, and Webflow AI must be enabled for the workspace.
-Required scope: `site_config:write`
+Each access token can have one AEO request in flight at a time, across all AEO Analytics endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
@@ -8617,27 +16535,28 @@ Required scope: `site_config:write`
-
```python
-from webflow import Webflow, RobotsRulesItem
+from webflow import Webflow
from webflow.environment import WebflowEnvironment
+import datetime
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.sites.robots_txt.delete(
+client.sites.aeo.reports.visibility_breakdown(
site_id="580e63e98c9a982ac9b8b741",
- rules=[
- RobotsRulesItem(
- user_agent="*",
- allows=[
- "/public"
- ],
- disallows=[
- "/bubbles"
- ],
- )
+ start_time=datetime.datetime.fromisoformat("2026-09-01T00:00:00+00:00"),
+ end_time=datetime.datetime.fromisoformat("2026-09-08T00:00:00+00:00"),
+ breakdown="topic",
+ limit=1,
+ topic_ids=[
+ "68cdb4b5a699862fcd8c1a02"
],
+ prompt_ids=[
+ "68cdb4b5a699862fcd8c1a01"
+ ],
+ answer_engine="chat-gpt",
)
```
@@ -8662,7 +16581,7 @@ client.sites.robots_txt.delete(
-
-**request:** `Robots`
+**start_time:** `datetime.datetime` — Inclusive start of the time range. Must be a UTC timestamp ending in `Z`, such as `2026-09-01T00:00:00Z`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional.
@@ -8670,89 +16589,39 @@ client.sites.robots_txt.delete(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**end_time:** `datetime.datetime` — Exclusive end of the time range. Must be a UTC timestamp ending in `Z`, and later than `startTime`. The range can be at most 100 days.
-
-
-
-
-
-
-client.sites.robots_txt.patch(...) -> Robots
-
-#### 📝 Description
-
-
--
+**breakdown:** `ReportsVisibilityBreakdownRequestBreakdown` — Return one row per `topic` or per `prompt`.
+
+
+
-
-Update the `robots.txt` configuration for various user agents.
-
-This endpoint requires an Enterprise workspace.
-
-Required scope | `site_config:write`
-
-
+**limit:** `typing.Optional[int]` — Maximum number of rows to return, up to `100`. Omit it to return every row.
+
-#### 🔌 Usage
-
-
-
--
-
-```python
-from webflow import Webflow, RobotsRulesItem
-from webflow.environment import WebflowEnvironment
-
-client = Webflow(
- access_token="",
- environment=WebflowEnvironment.DATA_API,
-)
-
-client.sites.robots_txt.patch(
- site_id="580e63e98c9a982ac9b8b741",
- rules=[
- RobotsRulesItem(
- user_agent="googlebot",
- allows=[
- "/public"
- ],
- disallows=[
- "/vogon-poetry",
- "/total-perspective-vortex"
- ],
- )
- ],
- sitemap="https://heartofgold.ship/sitemap.xml",
-)
-
-```
-
-
+**topic_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Include only these topics. Get topic IDs from [List Prompts](/data/reference/aeo-analytics/list-prompts). Repeat the parameter for more than one, up to 50.
+
-#### ⚙️ Parameters
-
-
--
-
-
-**site_id:** `str` — Unique identifier for a Site
+**prompt_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Include only these prompts. Get prompt IDs from [List Prompts](/data/reference/aeo-analytics/list-prompts). Repeat the parameter for more than one, up to 50.
@@ -8760,7 +16629,7 @@ client.sites.robots_txt.patch(
-
-**request:** `Robots`
+**answer_engine:** `typing.Optional[AeoAnswerEngineKey]` — Include only responses from this answer engine.
@@ -8780,8 +16649,7 @@ client.sites.robots_txt.patch(
client.sites.well_known.put(...)
+client.sites.aeo.reports.citation_rate(...) -> AeoCitationRateResponse
-
@@ -8793,20 +16661,15 @@ client.sites.robots_txt.patch(
-
-Upload a supported well-known file to a site.
+Returns, for each topic or prompt, the share of responses with citations that cited one of your domains.
-The current restrictions on well-known files are as follows:
- - Each file must be smaller than 100kb
- - Less than 30 total files
- - Have one of the following file extensions (or no extension): `.txt`, `.json`, `.noext`
+Your domains are your Allowed domains and your `webflow.io` subdomain, each with and without `www.`. The response lists them in `domains`. Results are sorted by `citationRate`, highest first, and aren't paginated. Separate filters combine with AND, and values within one filter combine with OR.
-
- `.noext` is a special file extension that removes other extensions. For example, `apple-app-site-association.noext.txt` will be uploaded as `apple-app-site-association`. Use this extension for tools that have trouble uploading extensionless files.
-
+This endpoint requires a site or workspace with the AEO analytics entitlement, and Webflow AI must be enabled for the workspace.
-This endpoint requires an Enterprise workspace.
+Each access token can have one AEO request in flight at a time, across all AEO Analytics endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
-Required scope: `site_config:write`
+Required scope | `sites:read`
@@ -8823,17 +16686,27 @@ Required scope: `site_config:write`
```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
+import datetime
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.sites.well_known.put(
+client.sites.aeo.reports.citation_rate(
site_id="580e63e98c9a982ac9b8b741",
- file_name="apple-app-site-association.txt",
- file_data="{\n \"applinks\": {\n \"apps\": [],\n \"details\": [\n {\n \"appID\": \"ABCDE12345.com.example.app\",\n \"paths\": [ \"/*\", \"/some/path/*\" ]\n }\n ]\n }\n}\n",
- content_type="application/json",
+ start_time=datetime.datetime.fromisoformat("2026-09-01T00:00:00+00:00"),
+ end_time=datetime.datetime.fromisoformat("2026-09-08T00:00:00+00:00"),
+ breakdown="topic",
+ topic_ids=[
+ "68cdb4b5a699862fcd8c1a02"
+ ],
+ prompt_ids=[
+ "68cdb4b5a699862fcd8c1a01"
+ ],
+ answer_engines=[
+ "chat-gpt"
+ ],
)
```
@@ -8858,7 +16731,7 @@ client.sites.well_known.put(
-
-**file_name:** `str` — The name of the file
+**start_time:** `datetime.datetime` — Inclusive start of the time range. Must be a UTC timestamp ending in `Z`, such as `2026-09-01T00:00:00Z`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional.
@@ -8866,7 +16739,31 @@ client.sites.well_known.put(
-
-**file_data:** `str` — The contents of the file
+**end_time:** `datetime.datetime` — Exclusive end of the time range. Must be a UTC timestamp ending in `Z`, and later than `startTime`. The range can be at most 100 days.
+
+
+
+
+
+-
+
+**breakdown:** `ReportsCitationRateRequestBreakdown` — Return one row per `topic` or per `prompt`.
+
+
+
+
+
+-
+
+**topic_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Include only these topics. Get topic IDs from [List Prompts](/data/reference/aeo-analytics/list-prompts). Repeat the parameter for more than one, up to 50.
+
+
+
+
+
+-
+
+**prompt_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Include only these prompts. Get prompt IDs from [List Prompts](/data/reference/aeo-analytics/list-prompts). Repeat the parameter for more than one, up to 50.
@@ -8874,7 +16771,7 @@ client.sites.well_known.put(
-
-**content_type:** `typing.Optional[WellKnownFileContentType]` — The content type of the file. Defaults to application/json
+**answer_engines:** `typing.Optional[typing.Union[AeoAnswerEngineKey, typing.Sequence[AeoAnswerEngineKey]]]` — Include only responses from these answer engines. Repeat the parameter for more than one, such as `answerEngines=chat-gpt&answerEngines=claude`.
@@ -8894,7 +16791,7 @@ client.sites.well_known.put(
client.sites.well_known.delete(...)
+client.sites.aeo.reports.top_cited_domains(...) -> AeoTopCitedDomainsResponse
-
@@ -8906,11 +16803,15 @@ client.sites.well_known.put(
-
-Delete existing well-known files from a site.
+Returns the domains answer engines cited most, with each domain's share of all citations. For your domains, each row also lists its cited paths in `paths`. For other domains, `distinctPathCount` gives the approximate number of distinct cited paths.
-This endpoint requires an Enterprise workspace.
+Results are sorted by citation count, highest first. If one of your domains isn't in the top `limit`, it's added after the ranked rows, so the response can have more than `limit` rows.
-Required scope: `site_config:write`
+This endpoint requires a site or workspace with the AEO analytics entitlement, and Webflow AI must be enabled for the workspace.
+
+Each access token can have one AEO request in flight at a time, across all AEO Analytics endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
@@ -8927,14 +16828,24 @@ Required scope: `site_config:write`
```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
+import datetime
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.sites.well_known.delete(
+client.sites.aeo.reports.top_cited_domains(
site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat("2026-09-01T00:00:00+00:00"),
+ end_time=datetime.datetime.fromisoformat("2026-09-08T00:00:00+00:00"),
+ topic_ids=[
+ "68cdb4b5a699862fcd8c1a02"
+ ],
+ answer_engines=[
+ "chat-gpt"
+ ],
+ limit=1,
)
```
@@ -8959,7 +16870,39 @@ client.sites.well_known.delete(
-
-**file_names:** `typing.Optional[typing.List[str]]` — A list of file names to delete
+**start_time:** `datetime.datetime` — Inclusive start of the time range. Must be a UTC timestamp ending in `Z`, such as `2026-09-01T00:00:00Z`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional.
+
+
+
+
+
+-
+
+**end_time:** `datetime.datetime` — Exclusive end of the time range. Must be a UTC timestamp ending in `Z`, and later than `startTime`. The range can be at most 100 days.
+
+
+
+
+
+-
+
+**topic_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Include only these topics. Get topic IDs from [List Prompts](/data/reference/aeo-analytics/list-prompts). Repeat the parameter for more than one, up to 50.
+
+
+
+
+
+-
+
+**answer_engines:** `typing.Optional[typing.Union[AeoAnswerEngineKey, typing.Sequence[AeoAnswerEngineKey]]]` — Include only responses from these answer engines. Repeat the parameter for more than one, such as `answerEngines=chat-gpt&answerEngines=claude`.
+
+
+
+
+
+-
+
+**limit:** `typing.Optional[int]` — Number of top domains to return. Defaults to `5`, up to a maximum of `100`.
@@ -8979,8 +16922,7 @@ client.sites.well_known.delete(
client.sites.activity_logs.list(...) -> SiteActivityLogResponse
+client.sites.aeo.reports.cited_domain_paths(...) -> AeoCitedDomainPathsResponse
-
@@ -8992,11 +16934,15 @@ client.sites.well_known.delete(
-
-Retrieve Activity Logs for a specific Site.
+Returns the cited paths on one domain, with each path's share of all citations.
-This endpoint requires an Enterprise workspace.
+`domain` can be any domain, not only yours. Results are sorted by `citationRate`, highest first, and aren't paginated.
-Required scope: `site_activity:read`
+This endpoint requires a site or workspace with the AEO analytics entitlement, and Webflow AI must be enabled for the workspace.
+
+Each access token can have one AEO request in flight at a time, across all AEO Analytics endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
@@ -9013,16 +16959,24 @@ Required scope: `site_activity:read`
```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
+import datetime
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.sites.activity_logs.list(
+client.sites.aeo.reports.cited_domain_paths(
site_id="580e63e98c9a982ac9b8b741",
- limit=1,
- offset=1,
+ start_time=datetime.datetime.fromisoformat("2026-09-01T00:00:00+00:00"),
+ end_time=datetime.datetime.fromisoformat("2026-09-08T00:00:00+00:00"),
+ domain="example.org",
+ topic_ids=[
+ "68cdb4b5a699862fcd8c1a02"
+ ],
+ answer_engines=[
+ "chat-gpt"
+ ],
)
```
@@ -9047,7 +17001,7 @@ client.sites.activity_logs.list(
-
-**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+**start_time:** `datetime.datetime` — Inclusive start of the time range. Must be a UTC timestamp ending in `Z`, such as `2026-09-01T00:00:00Z`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional.
@@ -9055,7 +17009,31 @@ client.sites.activity_logs.list(
-
-**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
+**end_time:** `datetime.datetime` — Exclusive end of the time range. Must be a UTC timestamp ending in `Z`, and later than `startTime`. The range can be at most 100 days.
+
+
+
+
+
+-
+
+**domain:** `str` — The domain, as a bare hostname such as `example.com`, with no scheme, path, or port. Matched exactly, so `www.example.com` is a different domain. Send internationalized domains in punycode.
+
+
+
+
+
+-
+
+**topic_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Include only these topics. Get topic IDs from [List Prompts](/data/reference/aeo-analytics/list-prompts). Repeat the parameter for more than one, up to 50.
+
+
+
+
+
+-
+
+**answer_engines:** `typing.Optional[typing.Union[AeoAnswerEngineKey, typing.Sequence[AeoAnswerEngineKey]]]` — Include only responses from these answer engines. Repeat the parameter for more than one, such as `answerEngines=chat-gpt&answerEngines=claude`.
@@ -9075,8 +17053,7 @@ client.sites.activity_logs.list(
client.sites.comments.list_comment_threads(...) -> CommentThreadList
+client.sites.aeo.reports.page_citation_share(...) -> AeoPageCitationShareResponse
-
@@ -9088,13 +17065,15 @@ client.sites.activity_logs.list(
-
-List all comment threads for a site.
+Returns one page's share of all citations to your domains, optionally broken down by prompt.
-
- There may be a delay of up to 5 minutes before new comments appear in the system.
-
+For a CMS item, send `collectionId` and `itemSlug` along with `pageId`. With `breakdown=prompt`, returns each prompt's share of this page's citations, sorted by `citationShare`, highest first.
-Required scope | `comments:read`
+This endpoint requires a site or workspace with the AEO analytics entitlement, and Webflow AI must be enabled for the workspace.
+
+Each access token can have one AEO request in flight at a time, across all AEO Analytics endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
@@ -9111,19 +17090,24 @@ Required scope | `comments:read`
```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
+import datetime
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.sites.comments.list_comment_threads(
+client.sites.aeo.reports.page_citation_share(
site_id="580e63e98c9a982ac9b8b741",
- locale_id="65427cf400e02b306eaa04a0",
- offset=1,
- limit=1,
- sort_by="createdOn",
- sort_order="asc",
+ start_time=datetime.datetime.fromisoformat("2026-09-01T00:00:00+00:00"),
+ end_time=datetime.datetime.fromisoformat("2026-09-08T00:00:00+00:00"),
+ page_id="68cdb4b5a699862fcd8c1a30",
+ collection_id="68cdb4b5a699862fcd8c1a40",
+ item_slug="dont-panic",
+ breakdown="prompt",
+ answer_engines=[
+ "chat-gpt"
+ ],
)
```
@@ -9148,11 +17132,15 @@ client.sites.comments.list_comment_threads(
-
-**locale_id:** `typing.Optional[str]`
+**start_time:** `datetime.datetime` — Inclusive start of the time range. Must be a UTC timestamp ending in `Z`, such as `2026-09-01T00:00:00Z`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional.
+
+
+
-Unique identifier for a specific Locale.
+
+-
-[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
+**end_time:** `datetime.datetime` — Exclusive end of the time range. Must be a UTC timestamp ending in `Z`, and later than `startTime`. The range can be at most 100 days.
@@ -9160,7 +17148,7 @@ Unique identifier for a specific Locale.
-
-**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
+**page_id:** `str` — The page ID. For a CMS item, the ID of its template page.
@@ -9168,7 +17156,7 @@ Unique identifier for a specific Locale.
-
-**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+**collection_id:** `typing.Optional[str]` — The CMS collection ID, for a CMS item. Send it with `itemSlug`.
@@ -9176,7 +17164,7 @@ Unique identifier for a specific Locale.
-
-**sort_by:** `typing.Optional[CommentsListCommentThreadsRequestSortBy]` — Sort results by the provided value. Only allowed when sortOrder is provided.
+**item_slug:** `typing.Optional[str]` — The CMS item's slug, for a CMS item. Send it with `collectionId`.
@@ -9184,7 +17172,15 @@ Unique identifier for a specific Locale.
-
-**sort_order:** `typing.Optional[CommentsListCommentThreadsRequestSortOrder]` — Sorts the results by asc or desc
+**breakdown:** `typing.Optional[typing.Literal]` — Set to `prompt` to return one row per prompt that cited the page.
+
+
+
+
+
+-
+
+**answer_engines:** `typing.Optional[typing.Union[AeoAnswerEngineKey, typing.Sequence[AeoAnswerEngineKey]]]` — Include only responses from these answer engines. Repeat the parameter for more than one, such as `answerEngines=chat-gpt&answerEngines=claude`.
@@ -9204,7 +17200,7 @@ Unique identifier for a specific Locale.
client.sites.comments.get_comment_thread(...) -> CommentThread
+client.sites.aeo.reports.competitor_citations(...) -> AeoCompetitorCitationsResponse
-
@@ -9216,13 +17212,15 @@ Unique identifier for a specific Locale.
-
-Get details of a specific comment thread.
+Lists the newest responses that cited a competitor's domain and none of your domains.
-
- There may be a delay of up to 5 minutes before new comments appear in the system.
-
+Competitor domains come from the competitors in the site's Organization info. Results are sorted by `timestamp`, newest first, and aren't paginated.
-Required scope | `comments:read`
+This endpoint requires a site or workspace with the AEO analytics entitlement, and Webflow AI must be enabled for the workspace.
+
+Each access token can have one AEO request in flight at a time, across all AEO Analytics endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
@@ -9239,20 +17237,24 @@ Required scope | `comments:read`
```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
+import datetime
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.sites.comments.get_comment_thread(
+client.sites.aeo.reports.competitor_citations(
site_id="580e63e98c9a982ac9b8b741",
- comment_thread_id="580e63e98c9a982ac9b8b741",
- locale_id="65427cf400e02b306eaa04a0",
- offset=1,
+ start_time=datetime.datetime.fromisoformat("2026-09-01T00:00:00+00:00"),
+ end_time=datetime.datetime.fromisoformat("2026-09-08T00:00:00+00:00"),
+ topic_ids=[
+ "68cdb4b5a699862fcd8c1a02"
+ ],
+ answer_engines=[
+ "chat-gpt"
+ ],
limit=1,
- sort_by="createdOn",
- sort_order="asc",
)
```
@@ -9277,19 +17279,7 @@ client.sites.comments.get_comment_thread(
-
-**comment_thread_id:** `str` — Unique identifier for a Comment Thread
-
-
-
-
-
--
-
-**locale_id:** `typing.Optional[str]`
-
-Unique identifier for a specific Locale.
-
-[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
+**start_time:** `datetime.datetime` — Inclusive start of the time range. Must be a UTC timestamp ending in `Z`, such as `2026-09-01T00:00:00Z`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional.
@@ -9297,7 +17287,7 @@ Unique identifier for a specific Locale.
-
-**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
+**end_time:** `datetime.datetime` — Exclusive end of the time range. Must be a UTC timestamp ending in `Z`, and later than `startTime`. The range can be at most 100 days.
@@ -9305,7 +17295,7 @@ Unique identifier for a specific Locale.
-
-**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+**topic_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Include only these topics. Get topic IDs from [List Prompts](/data/reference/aeo-analytics/list-prompts). Repeat the parameter for more than one, up to 50.
@@ -9313,7 +17303,7 @@ Unique identifier for a specific Locale.
-
-**sort_by:** `typing.Optional[CommentsGetCommentThreadRequestSortBy]` — Sort results by the provided value. Only allowed when sortOrder is provided.
+**answer_engines:** `typing.Optional[typing.Union[AeoAnswerEngineKey, typing.Sequence[AeoAnswerEngineKey]]]` — Include only responses from these answer engines. Repeat the parameter for more than one, such as `answerEngines=chat-gpt&answerEngines=claude`.
@@ -9321,7 +17311,7 @@ Unique identifier for a specific Locale.
-
-**sort_order:** `typing.Optional[CommentsGetCommentThreadRequestSortOrder]` — Sorts the results by asc or desc
+**limit:** `typing.Optional[int]` — Maximum number of responses to return. Defaults to `10`, up to a maximum of `1000`.
@@ -9341,7 +17331,7 @@ Unique identifier for a specific Locale.
client.sites.comments.list_comment_replies(...) -> CommentReplyList
+client.sites.aeo.reports.citations(...) -> AeoCitationsResponse
-
@@ -9353,13 +17343,15 @@ Unique identifier for a specific Locale.
-
-List all replies to a specific comment thread.
+Lists answer engine responses over a time range, newest first, with every citation and mention in each.
-
- There may be a delay of up to 5 minutes before new comments appear in the system.
-
+Includes responses that cited nothing. To get the next page, set `offset` to the previous `offset` plus `limit`. Rows can shift between pages if new responses arrive in the time range.
-Required scope | `comments:read`
+This endpoint requires a site or workspace with the AEO analytics entitlement, and Webflow AI must be enabled for the workspace.
+
+Each access token can have one AEO request in flight at a time, across all AEO Analytics endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
@@ -9376,20 +17368,28 @@ Required scope | `comments:read`
```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
+import datetime
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.sites.comments.list_comment_replies(
+client.sites.aeo.reports.citations(
site_id="580e63e98c9a982ac9b8b741",
- comment_thread_id="580e63e98c9a982ac9b8b741",
- locale_id="65427cf400e02b306eaa04a0",
- offset=1,
+ start_time=datetime.datetime.fromisoformat("2026-09-01T00:00:00+00:00"),
+ end_time=datetime.datetime.fromisoformat("2026-09-08T00:00:00+00:00"),
+ topic_ids=[
+ "68cdb4b5a699862fcd8c1a02"
+ ],
+ prompt_ids=[
+ "68cdb4b5a699862fcd8c1a01"
+ ],
+ answer_engines=[
+ "chat-gpt"
+ ],
limit=1,
- sort_by="createdOn",
- sort_order="asc",
+ offset=1,
)
```
@@ -9414,7 +17414,7 @@ client.sites.comments.list_comment_replies(
-
-**comment_thread_id:** `str` — Unique identifier for a Comment Thread
+**start_time:** `datetime.datetime` — Inclusive start of the time range. Must be a UTC timestamp ending in `Z`, such as `2026-09-01T00:00:00Z`. Offsets and date-only values aren't accepted. Seconds and milliseconds are optional.
@@ -9422,11 +17422,15 @@ client.sites.comments.list_comment_replies(
-
-**locale_id:** `typing.Optional[str]`
+**end_time:** `datetime.datetime` — Exclusive end of the time range. Must be a UTC timestamp ending in `Z`, and later than `startTime`. The range can be at most 100 days.
+
+
+
-Unique identifier for a specific Locale.
+
+-
-[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
+**topic_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Include only these topics. Get topic IDs from [List Prompts](/data/reference/aeo-analytics/list-prompts). Repeat the parameter for more than one, up to 50.
@@ -9434,7 +17438,7 @@ Unique identifier for a specific Locale.
-
-**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
+**prompt_ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — Include only these prompts. Get prompt IDs from [List Prompts](/data/reference/aeo-analytics/list-prompts). Repeat the parameter for more than one, up to 50.
@@ -9442,7 +17446,7 @@ Unique identifier for a specific Locale.
-
-**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+**answer_engines:** `typing.Optional[typing.Union[AeoAnswerEngineKey, typing.Sequence[AeoAnswerEngineKey]]]` — Include only responses from these answer engines. Repeat the parameter for more than one, such as `answerEngines=chat-gpt&answerEngines=claude`.
@@ -9450,7 +17454,7 @@ Unique identifier for a specific Locale.
-
-**sort_by:** `typing.Optional[CommentsListCommentRepliesRequestSortBy]` — Sort results by the provided value. Only allowed when sortOrder is provided.
+**limit:** `typing.Optional[int]` — Maximum number of responses to return. Defaults to `100`, up to a maximum of `1000`.
@@ -9458,7 +17462,7 @@ Unique identifier for a specific Locale.
-
-**sort_order:** `typing.Optional[CommentsListCommentRepliesRequestSortOrder]` — Sorts the results by asc or desc
+**offset:** `typing.Optional[int]` — Number of responses to skip. Defaults to `0`.
@@ -9478,8 +17482,8 @@ Unique identifier for a specific Locale.
client.sites.scripts.get_custom_code(...) -> ScriptApplyList
+## Sites Aeo Prompts
+client.sites.aeo.prompts.list(...) -> AeoPromptListResponse
-
@@ -9491,13 +17495,15 @@ Unique identifier for a specific Locale.
-
-Get all scripts applied to a site by the App.
+Lists the site's tracked prompts, with each prompt's topic and status. By default, returns `active`, `paused`, and `pending` prompts. To include archived prompts, set `status` to `archived` or `all`.
-
- To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
-
+Results are sorted by `createdAt`, newest first. To get the next page, pass `nextCursor` as `cursor`.
-Required scope | `custom_code:read`
+This endpoint requires a site or workspace with the AEO analytics entitlement, and Webflow AI must be enabled for the workspace.
+
+Each access token can have one AEO request in flight at a time, across all AEO Analytics endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
@@ -9520,8 +17526,12 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.sites.scripts.get_custom_code(
+client.sites.aeo.prompts.list(
site_id="580e63e98c9a982ac9b8b741",
+ topic_id="68cdb4b5a699862fcd8c1a02",
+ status="active",
+ limit=1,
+ cursor="cursor",
)
```
@@ -9546,6 +17556,38 @@ client.sites.scripts.get_custom_code(
-
+**topic_id:** `typing.Optional[str]` — Include only prompts in this topic. A topic that isn't on this site returns no prompts.
+
+
+
+
+
+-
+
+**status:** `typing.Optional[PromptsListRequestStatus]` — Include only prompts with this status. `all` includes every status. Omit it to include `active`, `paused`, and `pending` prompts.
+
+
+
+
+
+-
+
+**limit:** `typing.Optional[int]` — Maximum number of prompts to return. Defaults to `50`, up to a maximum of `100`.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The `nextCursor` from the previous page.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -9558,7 +17600,8 @@ client.sites.scripts.get_custom_code(
client.sites.scripts.upsert_custom_code(...) -> ScriptApplyList
+## Sites Aeo PromptExecutions
+client.sites.aeo.prompt_executions.list(...) -> AeoPromptExecutionListResponse
-
@@ -9570,13 +17613,15 @@ client.sites.scripts.get_custom_code(
-
-Apply registered scripts to a site. If you have multiple scripts your App needs to apply or maintain on a site, ensure they are always included in the request body for this endpoint. To remove individual scripts, simply call this endpoint without the script in the request body.
+Lists answer engine responses to the site's prompts, newest first, with the mentions and citations in each. Covers the last 90 days unless you set a time range.
-
- To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
-
+Executions older than 90 days aren't listed. Results are sorted by `createdAt`, newest first. To get the next page, pass `nextCursor` as `cursor`.
-Required scope | `custom_code:write`
+This endpoint requires a site or workspace with the AEO analytics entitlement, and Webflow AI must be enabled for the workspace.
+
+Each access token can have one AEO request in flight at a time, across all AEO Analytics endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
@@ -9591,31 +17636,25 @@ Required scope | `custom_code:write`
-
```python
-from webflow import Webflow, ScriptApply
+from webflow import Webflow
from webflow.environment import WebflowEnvironment
-
-client = Webflow(
- access_token="",
- environment=WebflowEnvironment.DATA_API,
-)
-
-client.sites.scripts.upsert_custom_code(
- site_id="580e63e98c9a982ac9b8b741",
- scripts=[
- ScriptApply(
- id="cms_slider",
- location="header",
- version="1.0.0",
- attributes={
- "my-attribute": "some-value"
- },
- ),
- ScriptApply(
- id="alert",
- location="header",
- version="0.0.1",
- )
- ],
+import datetime
+
+client = Webflow(
+ access_token="",
+ environment=WebflowEnvironment.DATA_API,
+)
+
+client.sites.aeo.prompt_executions.list(
+ site_id="580e63e98c9a982ac9b8b741",
+ prompt_id="68cdb4b5a699862fcd8c1a01",
+ topic_id="68cdb4b5a699862fcd8c1a02",
+ answer_engine="chat-gpt",
+ start_time=datetime.datetime.fromisoformat("2026-09-01T00:00:00+00:00"),
+ end_time=datetime.datetime.fromisoformat("2026-10-01T00:00:00+00:00"),
+ include_raw_response=True,
+ limit=1,
+ cursor="cursor",
)
```
@@ -9640,7 +17679,7 @@ client.sites.scripts.upsert_custom_code(
-
-**request:** `ScriptApplyList`
+**prompt_id:** `typing.Optional[str]` — Include only executions of this prompt. Can't be sent with `topicId`.
@@ -9648,78 +17687,55 @@ client.sites.scripts.upsert_custom_code(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**topic_id:** `typing.Optional[str]` — Include only executions of prompts in this topic. Can't be sent with `promptId`.
-
-
+
+-
+**answer_engine:** `typing.Optional[AeoAnswerEngineKey]` — Include only responses from this answer engine.
+
-client.sites.scripts.delete_custom_code(...)
-
-#### 📝 Description
-
-
--
+**start_time:** `typing.Optional[datetime.datetime]` — Include only executions created at or after this time. Must be a UTC timestamp ending in `Z`. Defaults to 90 days before `endTime`.
+
+
+
-
-Remove all scripts from a site applied by the App. This endpoint will not remove scripts from the site's registered scripts.
-
-To remove individual scripts applied by the App, use the [Add/Update Custom Code](/data/reference/custom-code/custom-code-sites/upsert-custom-code) endpoint.
-
-Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).
-
-Required scope | `custom_code:write`
-
-
+**end_time:** `typing.Optional[datetime.datetime]` — Include only executions created before this time. Must be a UTC timestamp ending in `Z`. Defaults to now. The range can be at most 90 days.
+
-#### 🔌 Usage
-
-
-
--
-
-```python
-from webflow import Webflow
-from webflow.environment import WebflowEnvironment
-
-client = Webflow(
- access_token="",
- environment=WebflowEnvironment.DATA_API,
-)
-
-client.sites.scripts.delete_custom_code(
- site_id="580e63e98c9a982ac9b8b741",
-)
-
-```
-
-
+**include_raw_response:** `typing.Optional[bool]` — Set to `true` to include each execution's full response text in `rawResponse`.
+
-#### ⚙️ Parameters
-
-
+**limit:** `typing.Optional[int]` — Maximum number of executions to return. Defaults to `25`, which is also the maximum.
+
+
+
+
-
-**site_id:** `str` — Unique identifier for a Site
+**cursor:** `typing.Optional[str]` — The `nextCursor` from the previous page.
@@ -9739,7 +17755,7 @@ client.sites.scripts.delete_custom_code(
client.sites.scripts.list_custom_code_blocks(...) -> ListCustomCodeBlocks
+client.sites.aeo.prompt_executions.get(...) -> AeoPromptExecution
-
@@ -9751,15 +17767,15 @@ client.sites.scripts.delete_custom_code(
-
-Get a list of scripts that have been applied to a site and/or individual pages.
+Returns one prompt execution, including the full response text while it's still stored.
-
- To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints.
+Executions older than 90 days are returned without `rawResponse`. Executions are deleted 120 days after they're created. This endpoint takes no query parameters.
- See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
-
+This endpoint requires a site or workspace with the AEO analytics entitlement, and Webflow AI must be enabled for the workspace.
-Required scope | `custom_code:read`
+Each access token can have one AEO request in flight at a time, across all AEO Analytics endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+Required scope | `sites:read`
@@ -9782,10 +17798,9 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.sites.scripts.list_custom_code_blocks(
+client.sites.aeo.prompt_executions.get(
site_id="580e63e98c9a982ac9b8b741",
- offset=1,
- limit=1,
+ execution_id="68cdb4b5a699862fcd8c1a10",
)
```
@@ -9810,15 +17825,7 @@ client.sites.scripts.list_custom_code_blocks(
-
-**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+**execution_id:** `str` — The prompt execution ID, from [List Prompt Executions](/data/reference/aeo-analytics/list-prompt-executions).
@@ -9838,8 +17845,8 @@ client.sites.scripts.list_custom_code_blocks(
client.sites.forms.list_submissions_by_site(...) -> FormSubmissionList
+## Workspaces AuditLogs
+client.workspaces.audit_logs.get_workspace_audit_logs(...) -> WorkspaceAuditLogResponse
-
@@ -9851,17 +17858,11 @@ client.sites.scripts.list_custom_code_blocks(
-
-List all form submissions for a given site with the ability to filter submissions by a centralized `elementId`.
-
-Add `elementId` when you want to filter form submissions to a specific form in a site. You can get the `elementId` from the [List forms endpoint](/data/reference/forms/forms/list) (displayed as `formElementId` in the response).
-
-
-When a form is used in a Webflow component definition, each instance of the component will yield a unique form. Adding the `elementId` in this request ensures this API response includes all submissions from that core form, wherever that form is used in instantiated components.
-
+Get audit logs for a workspace.
-Use the [List Form Submissions endpoint](/data/reference/forms/form-submissions/list-submissions) to list form submissions for a given form ID.
+This endpoint requires an Enterprise workspace and a workspace token with the `workspace_activity:read` scope. Create a workspace token from your workspace dashboard integrations page to use this endpoint.
-Required scope | `forms:read`
+Required scope | `workspace_activity:read`
@@ -9878,17 +17879,21 @@ Required scope | `forms:read`
```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
+import datetime
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.sites.forms.list_submissions_by_site(
- site_id="580e63e98c9a982ac9b8b741",
- element_id="18259716-3e5a-646a-5f41-5dc4b9405aa0",
- offset=1,
+client.workspaces.audit_logs.get_workspace_audit_logs(
+ workspace_id_or_slug="hitchhikers-workspace",
limit=1,
+ offset=1,
+ sort_order="asc",
+ event_type="user_access",
+ from_=datetime.datetime.fromisoformat("2025-06-22T16:00:31+00:00"),
+ to=datetime.datetime.fromisoformat("2025-07-22T16:00:31+00:00"),
)
```
@@ -9905,7 +17910,7 @@ client.sites.forms.list_submissions_by_site(
-
-**site_id:** `str` — Unique identifier for a Site
+**workspace_id_or_slug:** `str` — Unique identifier or slug for a Workspace
@@ -9913,7 +17918,7 @@ client.sites.forms.list_submissions_by_site(
-
-**element_id:** `typing.Optional[str]` — Identifier for an element
+**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
@@ -9929,7 +17934,31 @@ client.sites.forms.list_submissions_by_site(
-
-**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+**sort_order:** `typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestSortOrder]` — Sorts the results by asc or desc
+
+
+
+
+
+-
+
+**event_type:** `typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestEventType]` — The event type to filter by
+
+
+
+
+
+-
+
+**from:** `typing.Optional[datetime.datetime]` — The start date to filter by
+
+
+
+
+
+-
+
+**to:** `typing.Optional[datetime.datetime]` — The end date to filter by
@@ -9949,7 +17978,8 @@ client.sites.forms.list_submissions_by_site(
client.sites.forms.list_submissions(...) -> FormSubmissionList
+## Workspaces Members
+client.workspaces.members.list_members(...) -> WorkspaceMembersResponse
-
@@ -9961,11 +17991,11 @@ client.sites.forms.list_submissions_by_site(
-
-List form submissions for a given form ID within a specific site.
+List the members and invites of a workspace. `invites` includes pending, declined, and expired invites.
-Use the [List Form Submissions by Site endpoint](/data/reference/forms/form-submissions/list-submissions-by-site) to list form submissions for a given site with the ability to filter by a `formElementId`.
+This endpoint requires an Enterprise workspace.
-Required scope | `forms:read`
+Required scope | `workspace_members:read`
@@ -9988,11 +18018,14 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.sites.forms.list_submissions(
- site_id="580e63e98c9a982ac9b8b741",
- form_id="580e63e98c9a982ac9b8b741",
- offset=1,
+client.workspaces.members.list_members(
+ workspace_id="580e63e98c9a982ac9b8b741",
limit=1,
+ email="email",
+ roles=[
+ "owner"
+ ],
+ cursor="cursor",
)
```
@@ -10009,7 +18042,7 @@ client.sites.forms.list_submissions(
-
-**site_id:** `str` — Unique identifier for a Site
+**workspace_id:** `str` — Unique identifier for a Workspace. Find it with [List Workspaces](/data/reference/enterprise/workspace-management/list) (workspace API tokens and Data Client apps), or with `authorization.authorizedTo.workspaceIds` from [Get Authorization Info](/data/reference/token/introspect). With a site token, read `workspaceId` from [Get Site](/data/reference/sites/get).
@@ -10017,7 +18050,7 @@ client.sites.forms.list_submissions(
-
-**form_id:** `str` — Unique identifier for a Form
+**limit:** `typing.Optional[int]` — Maximum number of records to return. Defaults to `50`, up to a maximum of `100`.
@@ -10025,7 +18058,7 @@ client.sites.forms.list_submissions(
-
-**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
+**email:** `typing.Optional[str]` — Filter to the Member or invite with this email address
@@ -10033,7 +18066,15 @@ client.sites.forms.list_submissions(
-
-**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+**roles:** `typing.Optional[typing.Union[MembersListMembersRequestRolesItem, typing.Sequence[MembersListMembersRequestRolesItem]]]` — Comma-separated Workspace Roles to filter Members and invites by
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — Cursor returned in `pagination.nextCursor` of the previous response
@@ -10053,7 +18094,7 @@ client.sites.forms.list_submissions(
client.sites.forms.get_submission(...) -> FormSubmission
+client.workspaces.members.invite_member(...) -> InviteWorkspaceMemberResponseBody
-
@@ -10065,9 +18106,29 @@ client.sites.forms.list_submissions(
-
-Get information about a form submission within a specific site.
+Invite a user to a workspace.
-Required scope | `forms:read`
+Set `workspaceRole` to `client` to invite a collaborator client to one Site. Client invites require exactly one `siteAccess` entry. Repeat the request with another Site to extend a compatible pending client invite.
+
+Client invites create collaborator relationships only. This endpoint does not accept `sitePlan` or `canPublish`.
+
+This endpoint requires an Enterprise workspace.
+
+Required scope | `workspace_members:write`
+
+`workspaceRole` and `defaultSiteRole` together decide what the invitee can do and what role the dashboard shows for them once they accept. Submit only one of the combinations below — the dashboard's own role picker never produces any other pairing.
+
+| `workspaceRole` | `defaultSiteRole` | Shown in the dashboard as |
+|---|---|---|
+| `admin` | `site_manager` | Admin |
+| `member` | `site_manager` | Site manager |
+| `member` | `designer` | Designer |
+| `member` | `marketer` | Marketer |
+| `member` | `content_editor` | Content editor |
+| `member` | `custom` | The custom Site Role's own name. Requires `defaultSiteRoleId`. |
+| `reviewer` | `reviewer` | Reviewer |
+
+Admins always have access to every site in the workspace, so an Admin invite can't include a list of specific sites. For Member and Reviewer invites, you can either give the same role on all sites, or list specific sites. In both cases, use the pairings in the table above.
@@ -10082,7 +18143,7 @@ Required scope | `forms:read`
-
```python
-from webflow import Webflow
+from webflow import Webflow, WithDefaultSiteRole
from webflow.environment import WebflowEnvironment
client = Webflow(
@@ -10090,9 +18151,13 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.sites.forms.get_submission(
- site_id="580e63e98c9a982ac9b8b741",
- form_submission_id="580e63e98c9a982ac9b8b741",
+client.workspaces.members.invite_member(
+ workspace_id="580e63e98c9a982ac9b8b741",
+ request=WithDefaultSiteRole(
+ email="sam.okafor@example.com",
+ workspace_role="member",
+ default_site_role="designer",
+ ),
)
```
@@ -10109,7 +18174,7 @@ client.sites.forms.get_submission(
-
-**site_id:** `str` — Unique identifier for a Site
+**workspace_id:** `str` — Unique identifier for a Workspace. Find it with [List Workspaces](/data/reference/enterprise/workspace-management/list) (workspace API tokens and Data Client apps), or with `authorization.authorizedTo.workspaceIds` from [Get Authorization Info](/data/reference/token/introspect). With a site token, read `workspaceId` from [Get Site](/data/reference/sites/get).
@@ -10117,7 +18182,7 @@ client.sites.forms.get_submission(
-
-**form_submission_id:** `str` — Unique identifier for a Form Submission
+**request:** `InviteWorkspaceMemberRequestBody`
@@ -10137,7 +18202,7 @@ client.sites.forms.get_submission(
client.sites.forms.delete_submission(...)
+client.workspaces.members.remove_member(...)
-
@@ -10149,9 +18214,11 @@ client.sites.forms.get_submission(
-
-Delete a form submission within a specific site.
+Remove a member from a workspace.
-Required scope | `forms:write`
+This endpoint requires an Enterprise workspace.
+
+Required scope | `workspace_members:write`
@@ -10174,9 +18241,9 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.sites.forms.delete_submission(
- site_id="580e63e98c9a982ac9b8b741",
- form_submission_id="580e63e98c9a982ac9b8b741",
+client.workspaces.members.remove_member(
+ workspace_id="580e63e98c9a982ac9b8b741",
+ member_id="62fa5e47f6b8256f4641c5bd",
)
```
@@ -10193,7 +18260,7 @@ client.sites.forms.delete_submission(
-
-**site_id:** `str` — Unique identifier for a Site
+**workspace_id:** `str` — Unique identifier for a Workspace. Find it with [List Workspaces](/data/reference/enterprise/workspace-management/list) (workspace API tokens and Data Client apps), or with `authorization.authorizedTo.workspaceIds` from [Get Authorization Info](/data/reference/token/introspect). With a site token, read `workspaceId` from [Get Site](/data/reference/sites/get).
@@ -10201,7 +18268,7 @@ client.sites.forms.delete_submission(
-
-**form_submission_id:** `str` — Unique identifier for a Form Submission
+**member_id:** `str` — Unique identifier for a Member
@@ -10221,7 +18288,7 @@ client.sites.forms.delete_submission(
client.sites.forms.update_submission(...) -> FormSubmission
+client.workspaces.members.update_member_role(...) -> WorkspaceMember
-
@@ -10233,9 +18300,23 @@ client.sites.forms.delete_submission(
-
-Update hidden fields on a form submission within a specific site.
+Update a workspace member's role.
-Required scope | `forms:write`
+This endpoint requires an Enterprise workspace.
+
+Required scope | `workspace_members:write`
+
+`role` and `defaultSiteRole` together decide what the member can do and what role the dashboard shows for them. Submit only one of the combinations below — the dashboard's own role picker never produces any other pairing.
+
+| `role` | `defaultSiteRole` | Shown in the dashboard as |
+|---|---|---|
+| `admin` | `site_manager` | Admin |
+| `member` | `site_manager` | Site manager |
+| `member` | `designer` | Designer |
+| `member` | `marketer` | Marketer |
+| `member` | `content_editor` | Content editor |
+| `member` | `custom` | The custom Site Role's own name. Requires `defaultSiteRoleId`. |
+| `reviewer` | `reviewer` | Reviewer |
@@ -10258,9 +18339,11 @@ client = Webflow(
environment=WebflowEnvironment.DATA_API,
)
-client.sites.forms.update_submission(
- site_id="580e63e98c9a982ac9b8b741",
- form_submission_id="580e63e98c9a982ac9b8b741",
+client.workspaces.members.update_member_role(
+ workspace_id="580e63e98c9a982ac9b8b741",
+ member_id="62fa5e47f6b8256f4641c5bd",
+ role="admin",
+ default_site_role="site_manager",
)
```
@@ -10277,7 +18360,7 @@ client.sites.forms.update_submission(
-
-**site_id:** `str` — Unique identifier for a Site
+**workspace_id:** `str` — Unique identifier for a Workspace. Find it with [List Workspaces](/data/reference/enterprise/workspace-management/list) (workspace API tokens and Data Client apps), or with `authorization.authorizedTo.workspaceIds` from [Get Authorization Info](/data/reference/token/introspect). With a site token, read `workspaceId` from [Get Site](/data/reference/sites/get).
@@ -10285,7 +18368,7 @@ client.sites.forms.update_submission(
-
-**form_submission_id:** `str` — Unique identifier for a Form Submission
+**member_id:** `str` — Unique identifier for a Member
@@ -10293,7 +18376,23 @@ client.sites.forms.update_submission(
-
-**form_submission_data:** `typing.Optional[typing.Dict[str, typing.Any]]` — An existing **hidden field** defined on the form schema, and the corresponding value to set
+**role:** `UpdateWorkspaceMemberRoleRequestBodyRole` — The Workspace Role to assign
+
+
+
+
+
+-
+
+**default_site_role:** `UpdateWorkspaceMemberRoleRequestBodyDefaultSiteRole` — The Member's default Site Role. Required on every request — unlike the dashboard's own role editor, this endpoint never derives it from the Member's current role.
+
+
+
+
+
+-
+
+**default_site_role_id:** `typing.Optional[str]` — ID of the custom Site Role named by `defaultSiteRole`. Requires `defaultSiteRole` to be `custom`, and rejected with any other `defaultSiteRole`. Rejected if the id doesn't name a custom Site Role belonging to this workspace.
@@ -10313,8 +18412,7 @@ client.sites.forms.update_submission(
client.workspaces.audit_logs.get_workspace_audit_logs(...) -> WorkspaceAuditLogResponse
+client.workspaces.members.bulk_update_member_roles(...) -> WorkspaceBulkRoleChangeResponse
-
@@ -10326,11 +18424,25 @@ client.sites.forms.update_submission(
-
-Get audit logs for a workspace.
+Update the role of multiple workspace members and invites in one request. An invite can be updated regardless of status — pending, declined, or expired.
-This endpoint requires an Enterprise workspace and a workspace token with the `workspace_activity:read` scope. Create a workspace token from your workspace dashboard integrations page to use this endpoint.
+This answers `200` once the batch is applied, even when every item failed — a per-item problem is reported in `results` rather than failing the whole request. IDs are deduplicated before processing, so `results` can be shorter than the request; match a result back to your input by `id`, not by position.
-Required scope | `workspace_activity:read`
+This endpoint requires an Enterprise workspace.
+
+Required scope | `workspace_members:write`
+
+`role` and `defaultSiteRole` together decide what every id in the batch can do and what role the dashboard shows for them. Submit only one of the combinations below — the dashboard's own role picker never produces any other pairing.
+
+| `role` | `defaultSiteRole` | Shown in the dashboard as |
+|---|---|---|
+| `admin` | `site_manager` | Admin |
+| `member` | `site_manager` | Site manager |
+| `member` | `designer` | Designer |
+| `member` | `marketer` | Marketer |
+| `member` | `content_editor` | Content editor |
+| `member` | `custom` | The custom Site Role's own name. Requires `defaultSiteRoleId`. |
+| `reviewer` | `reviewer` | Reviewer |
@@ -10347,21 +18459,23 @@ Required scope | `workspace_activity:read`
```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
-import datetime
client = Webflow(
access_token="",
environment=WebflowEnvironment.DATA_API,
)
-client.workspaces.audit_logs.get_workspace_audit_logs(
- workspace_id_or_slug="hitchhikers-workspace",
- limit=1,
- offset=1,
- sort_order="asc",
- event_type="user_access",
- from_=datetime.datetime.fromisoformat("2025-06-22T16:00:31+00:00"),
- to=datetime.datetime.fromisoformat("2025-07-22T16:00:31+00:00"),
+client.workspaces.members.bulk_update_member_roles(
+ workspace_id="580e63e98c9a982ac9b8b741",
+ member_ids=[
+ "62fa5e47f6b8256f4641c5bd",
+ "62fa5e47f6b8256f4641c5be"
+ ],
+ invite_ids=[
+ "63fa5e47f6b8256f4641c5bf"
+ ],
+ role="member",
+ default_site_role="designer",
)
```
@@ -10378,15 +18492,7 @@ client.workspaces.audit_logs.get_workspace_audit_logs(
-
-**workspace_id_or_slug:** `str` — Unique identifier or slug for a Workspace
-
-
-
-
-
--
-
-**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
+**workspace_id:** `str` — Unique identifier for a Workspace. Find it with [List Workspaces](/data/reference/enterprise/workspace-management/list) (workspace API tokens and Data Client apps), or with `authorization.authorizedTo.workspaceIds` from [Get Authorization Info](/data/reference/token/introspect). With a site token, read `workspaceId` from [Get Site](/data/reference/sites/get).
@@ -10394,7 +18500,7 @@ client.workspaces.audit_logs.get_workspace_audit_logs(
-
-**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
+**role:** `BulkUpdateWorkspaceMemberRolesRequestBodyRole` — The Workspace Role to assign to every id in the batch
@@ -10402,7 +18508,7 @@ client.workspaces.audit_logs.get_workspace_audit_logs(
-
-**sort_order:** `typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestSortOrder]` — Sorts the results by asc or desc
+**default_site_role:** `BulkUpdateWorkspaceMemberRolesRequestBodyDefaultSiteRole` — The default Site Role to assign to every id in the batch
@@ -10410,7 +18516,7 @@ client.workspaces.audit_logs.get_workspace_audit_logs(
-
-**event_type:** `typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestEventType]` — The event type to filter by
+**member_ids:** `typing.Optional[typing.List[str]]` — IDs of active Members to update
@@ -10418,7 +18524,7 @@ client.workspaces.audit_logs.get_workspace_audit_logs(
-
-**from:** `typing.Optional[datetime.datetime]` — The start date to filter by
+**invite_ids:** `typing.Optional[typing.List[str]]` — IDs of invites to update, regardless of status
@@ -10426,7 +18532,7 @@ client.workspaces.audit_logs.get_workspace_audit_logs(
-
-**to:** `typing.Optional[datetime.datetime]` — The end date to filter by
+**default_site_role_id:** `typing.Optional[str]` — ID of the custom Site Role named by `defaultSiteRole`. Requires `defaultSiteRole` to be `custom`, and rejected with any other `defaultSiteRole`. Rejected if the id doesn't name a custom Site Role belonging to this workspace.
diff --git a/src/webflow/__init__.py b/src/webflow/__init__.py
index 48d06737..4b1bdeb0 100644
--- a/src/webflow/__init__.py
+++ b/src/webflow/__init__.py
@@ -7,6 +7,64 @@
if typing.TYPE_CHECKING:
from .types import (
+ AeoAnswerEngine,
+ AeoAnswerEngineKey,
+ AeoAnswerEnginesFilter,
+ AeoBotCategory,
+ AeoBotProvider,
+ AeoBotTrafficFilter,
+ AeoBotTrafficPage,
+ AeoBotTrafficPagesResponse,
+ AeoBotTrafficResponse,
+ AeoBrandNames,
+ AeoCitationFilter,
+ AeoCitationRateResponse,
+ AeoCitationRateResponseBreakdown,
+ AeoCitationRateResponseDataItem,
+ AeoCitationsResponse,
+ AeoCitationsResponseDataItem,
+ AeoCitedDomainPathsResponse,
+ AeoCitedPath,
+ AeoCompetitorCitationsResponse,
+ AeoCompetitorCitationsResponseDataItem,
+ AeoOwnedCitedPath,
+ AeoPage,
+ AeoPageCitationShareResponse,
+ AeoPageCitationShareResponseDataItem,
+ AeoPageCitationShareResponseFilter,
+ AeoPageCitationShareResponsePage,
+ AeoPrompt,
+ AeoPromptExecution,
+ AeoPromptExecutionListResponse,
+ AeoPromptExecutionPromptStatus,
+ AeoPromptExecutionStatus,
+ AeoPromptExecutionTopic,
+ AeoPromptIdsFilter,
+ AeoPromptLabel,
+ AeoPromptListResponse,
+ AeoPromptStatus,
+ AeoPromptTopic,
+ AeoTimeseries,
+ AeoTimeseriesGranularityPeriod,
+ AeoTopCitedDomainsResponse,
+ AeoTopCitedDomainsResponseDataItem,
+ AeoTopicEngineFilter,
+ AeoTopicIdsFilter,
+ AeoTopicLabel,
+ AeoVisibilityBreakdownResponse,
+ AeoVisibilityBreakdownResponseBreakdown,
+ AeoVisibilityBreakdownResponseDataItem,
+ AeoVisibilityFilter,
+ AeoVisibilityResponse,
+ AeoVisibilityResponseDataItem,
+ AeoVisibilityScore,
+ AeoWindow,
+ AnalyzeBucketTimeZone,
+ AnalyzeDailyBucketing,
+ AnalyzeDailyTimeseriesQuery,
+ AnalyzeFilterOperators,
+ AnalyzeTimeOnPageBucketing,
+ AnalyzeWindow,
Application,
Asset,
AssetFolder,
@@ -20,8 +78,18 @@
AuthorizationAuthorizationAuthorizedTo,
AuthorizedUser,
BadRequestErrorBody,
+ BranchCreatedWebhook,
+ BranchCreatedWebhookPayload,
+ BranchDeletedWebhook,
+ BranchDeletedWebhookPayload,
+ BranchMergedWebhook,
+ BranchMergedWebhookPayload,
+ BrowserWindowHeightDataPoint,
+ BrowserWindowHeightFilter,
+ BrowserWindowHeightResponse,
BulkCollectionItem,
BulkCollectionItemFieldData,
+ CollaboratorClientInvite,
Collection,
CollectionItem,
CollectionItemChanged,
@@ -49,6 +117,7 @@
CommentPayload,
CommentPayloadAuthor,
CommentPayloadMentionedUsersItem,
+ CommentPayloadType,
CommentReply,
CommentReplyAuthor,
CommentReplyList,
@@ -67,12 +136,27 @@
ComponentNode,
ComponentProperties,
ComponentProperty,
- ComponentPropertyType,
+ ComponentPropertyText,
+ ComponentPropertyTextType,
Conflict,
CustomCodeBlock,
CustomCodeBlockType,
CustomCodeHostedResponse,
CustomCodeInlineResponse,
+ CustomFont,
+ CustomFontAxis,
+ CustomFontBatchCreateResponse,
+ CustomFontBatchCreateResponseCreatedItem,
+ CustomFontBatchCreateResponseFailedItem,
+ CustomFontBatchDeleteResponse,
+ CustomFontBatchDeleteResponseDeletedItem,
+ CustomFontBatchDeleteResponseFailedItem,
+ CustomFontCreateResponse,
+ CustomFontFontDisplay,
+ CustomFontFormat,
+ CustomFontUpload,
+ CustomFontUploadFields,
+ CustomFonts,
CustomRole,
CustomRoleAuditLogItem,
CustomRoleAuditLogItemEventSubType,
@@ -84,10 +168,10 @@
ErrorCode,
Field,
FieldCreate,
+ FieldGroup,
FieldType,
FieldValidations,
FieldValidationsAdditionalProperties,
- FieldValidationsAdditionalPropertiesAdditionalProperties,
ForbiddenErrorBody,
Form,
FormField,
@@ -101,14 +185,47 @@
FormSubmissionTriggerPayload,
FormSubmissionTriggerPayloadSchemaItem,
FormSubmissionTriggerPayloadSchemaItemFieldType,
+ Goal,
+ GoalCategory,
+ GoalIntegrationSource,
+ GoalPerformanceDataPoint,
+ GoalPerformanceFilter,
+ GoalPerformanceResponse,
+ GoalScope,
+ GoalType,
+ GoalValueType,
+ GoalsResponse,
+ GoogleTagId,
+ GoogleTagIds,
ImageNode,
ImageNodeImage,
+ InsertCollectionItem,
+ InsertCollectionItemFieldData,
+ InsertedCollectionItem,
+ InsertedCollectionItemFieldData,
InvalidDomain,
InvalidScopes,
InventoryItem,
InventoryItemInventoryType,
+ InviteWorkspaceMemberRequestBody,
+ InviteWorkspaceMemberRequestBodyDefaultSiteRoleDefaultSiteRole,
+ InviteWorkspaceMemberRequestBodyDefaultSiteRoleWorkspaceRole,
+ InviteWorkspaceMemberRequestBodyEmailSiteAccessItem,
+ InviteWorkspaceMemberRequestBodyEmailSiteAccessItemSiteRole,
+ InviteWorkspaceMemberRequestBodyOneSiteAccessItem,
+ InviteWorkspaceMemberRequestBodyOneSiteAccessItemSiteRole,
+ InviteWorkspaceMemberRequestBodyOneWorkspaceRole,
+ InviteWorkspaceMemberResponseBody,
+ InviteWorkspaceMemberResponseBodyActive,
+ InviteWorkspaceMemberResponseBody_Active,
+ InviteWorkspaceMemberResponseBody_Invited,
+ Invited,
+ ItemsListItemsLiveRequestCreatedOn,
ItemsListItemsLiveRequestLastPublished,
+ ItemsListItemsLiveRequestLastUpdated,
+ ItemsListItemsRequestCreatedOn,
ItemsListItemsRequestLastPublished,
+ ItemsListItemsRequestLastUpdated,
ListCustomCodeBlocks,
Locale,
Locales,
@@ -126,6 +243,46 @@
Node_TextInput,
NotEnterprisePlanSite,
NotEnterprisePlanWorkspace,
+ Optimization,
+ OptimizationAudienceInsightsResponse,
+ OptimizationDimensionValuesResponse,
+ OptimizationDimensionsResponse,
+ OptimizationGoalsResponse,
+ OptimizationInterval,
+ OptimizationListResponse,
+ OptimizationStatus,
+ OptimizationSummaryResponse,
+ OptimizationTrendResponse,
+ OptimizationType,
+ OptimizeAppliedFilter,
+ OptimizeAppliedFilterEntry,
+ OptimizeAudienceSegment,
+ OptimizeAudienceVariation,
+ OptimizeCurrentGoal,
+ OptimizeDimension,
+ OptimizeDimensionValue,
+ OptimizeFilter,
+ OptimizeFilterOperators,
+ OptimizeGoal,
+ OptimizeGoalCountingMethod,
+ OptimizeGoalMetricType,
+ OptimizeGoalScope,
+ OptimizeGoalSource,
+ OptimizeNonWebflowSiteResource,
+ OptimizeReference,
+ OptimizeReferenceListResponse,
+ OptimizeReferenceResource,
+ OptimizeReferenceResource_OptimizeSite,
+ OptimizeReferenceResource_WebflowSite,
+ OptimizeReportGoal,
+ OptimizeReportIntervalEnd,
+ OptimizeReportIntervalStart,
+ OptimizeTrendDirection,
+ OptimizeTrendGranularity,
+ OptimizeTrendPoint,
+ OptimizeVariationComparison,
+ OptimizeVariationResult,
+ OptimizeWebflowSiteResource,
OptionField,
Order,
OrderAddress,
@@ -156,6 +313,11 @@
PageCreatedWebhookPayload,
PageDeletedWebhook,
PageDeletedWebhookPayload,
+ PageFlowDirection,
+ PageFlowFilter,
+ PageFlowMetricScope,
+ PageFlowResponse,
+ PageFlowRow,
PageList,
PageMetadataUpdatedWebhook,
PageMetadataUpdatedWebhookPayload,
@@ -165,6 +327,7 @@
Payload,
PayloadFieldData,
PaypalDetails,
+ PersonActor,
Product,
ProductAndSkUs,
ProductAndSkUsList,
@@ -184,6 +347,9 @@
ScriptApplyList,
ScriptApplyLocation,
Scripts,
+ ScrollDepthDataPoint,
+ ScrollDepthFilter,
+ ScrollDepthResponse,
SearchButtonNode,
SearchButtonNodeWrite,
Select,
@@ -196,11 +362,19 @@
SingleLocaleCreatedPayloadFieldData,
Site,
SiteActivityLogItem,
+ SiteActivityLogItemActorType,
SiteActivityLogItemEvent,
SiteActivityLogItemResourceOperation,
+ SiteActivityLogItemSource,
SiteActivityLogItemUser,
SiteActivityLogResponse,
SiteDataCollectionType,
+ SiteMember,
+ SiteMemberRoles,
+ SiteMemberRolesSite,
+ SiteMemberRolesWorkspace,
+ SiteMembersResponse,
+ SiteMembersResponsePagination,
SiteMembership,
SiteMembershipAuditLogItem,
SiteMembershipAuditLogItemEventSubType,
@@ -209,6 +383,7 @@
SitePlanName,
SitePublish,
SitePublishPayload,
+ SitePublishPayloadPublishScope,
Sites,
Sku,
SkuFieldData,
@@ -236,7 +411,36 @@
TextNode,
TextNodeText,
TextNodeWrite,
+ TimeOnPageDataPoint,
+ TimeOnPageFilter,
+ TimeOnPageGranularityPeriod,
+ TimeOnPageMetricScope,
+ TimeOnPageResponse,
+ TimeOnPageTimeseriesQuery,
+ TokenActor,
+ TopDimensionsDimension,
+ TopDimensionsFilter,
+ TopDimensionsMetricScope,
+ TopDimensionsResponse,
+ TopDimensionsRow,
+ TopEventsCmsContextEntry,
+ TopEventsComponentContextEntry,
+ TopEventsFilter,
+ TopEventsResponse,
+ TopEventsRow,
+ TopEventsTimeseriesPoint,
+ TopPagesFilter,
+ TopPagesResponse,
+ TopPagesRow,
+ TopPagesSortBy,
+ TopPagesTimeseriesPoint,
+ TrafficDataPoint,
+ TrafficFilter,
+ TrafficMetricScope,
+ TrafficResponse,
TriggerType,
+ UpdateSiteMemberRoleRequestBody,
+ UpdateSiteMemberRoleRequestBodySiteRole,
UpdatedOrder,
UserAccess,
UserAccessAuditLogItem,
@@ -244,9 +448,13 @@
Webhook,
WebhookFilter,
WebhookList,
+ WithDefaultSiteRole,
+ WithSiteAccess,
+ Workspace,
+ WorkspaceAuditLogActor,
+ WorkspaceAuditLogActor_Person,
+ WorkspaceAuditLogActor_Token,
WorkspaceAuditLogItem,
- WorkspaceAuditLogItemActor,
- WorkspaceAuditLogItemPayloadSettingChangeMethod,
WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess,
WorkspaceAuditLogItemPayloadSiteMembershipMethod,
WorkspaceAuditLogItemPayloadSiteMembershipSite,
@@ -268,12 +476,30 @@
WorkspaceAuditLogItem_WorkspaceMembership,
WorkspaceAuditLogItem_WorkspaceSetting,
WorkspaceAuditLogResponse,
+ WorkspaceBulkRoleChangeResponse,
+ WorkspaceBulkRoleChangeResponseResultsItem,
+ WorkspaceBulkRoleChangeResponseResultsItemError,
+ WorkspaceBulkRoleChangeResponseResultsItemErrorCode,
+ WorkspaceBulkRoleChangeResponseResultsItemOutcome,
+ WorkspaceBulkRoleChangeResponseResultsItemType,
+ WorkspaceBulkRoleChangeResponseSummary,
WorkspaceInvitation,
WorkspaceInvitationAuditLogItem,
WorkspaceInvitationAuditLogItemEventSubType,
+ WorkspaceInvite,
+ WorkspaceInviteDefaultSiteRole,
+ WorkspaceInviteRole,
+ WorkspaceInviteStatus,
+ WorkspaceMember,
+ WorkspaceMemberRoles,
+ WorkspaceMemberRolesSite,
+ WorkspaceMemberRolesWorkspace,
+ WorkspaceMembersResponse,
+ WorkspaceMembersResponsePagination,
WorkspaceMembership,
WorkspaceMembershipAuditLogItem,
WorkspaceMembershipAuditLogItemEventSubType,
+ Workspaces,
)
from .errors import (
BadRequestError,
@@ -281,6 +507,7 @@
ForbiddenError,
InternalServerError,
NotFoundError,
+ ServiceUnavailableError,
TooManyRequestsError,
UnauthorizedError,
)
@@ -289,6 +516,13 @@
ComponentPropertiesWritePropertiesItem,
ComponentsUpdateContentResponse,
ComponentsUpdatePropertiesResponse,
+ CustomFontBatchCreateRequestItemsItem,
+ CustomFontBatchCreateRequestItemsItemFontDisplay,
+ CustomFontBatchDeleteRequestItemsItem,
+ CustomFontsCreateRequestFontDisplay,
+ CustomFontsGetResponse,
+ CustomFontsUpdateRequestFontDisplay,
+ CustomFontsUpdateResponse,
EcommInventoryChangedPayload,
InventoryUpdateRequestInventoryType,
OrdersListRequestStatus,
@@ -300,13 +534,17 @@
ProductSkuCreateSku,
ProductsCreateSkuResponse,
SitesPublishResponse,
+ SitesPublishResponsePublishScope,
UpdateStaticContentResponse,
+ analyze,
assets,
collections,
components,
+ custom_fonts,
ecommerce,
forms,
inventory,
+ optimize,
orders,
pages,
products,
@@ -320,6 +558,64 @@
from .environment import WebflowEnvironment
from .version import __version__
_dynamic_imports: typing.Dict[str, str] = {
+ "AeoAnswerEngine": ".types",
+ "AeoAnswerEngineKey": ".types",
+ "AeoAnswerEnginesFilter": ".types",
+ "AeoBotCategory": ".types",
+ "AeoBotProvider": ".types",
+ "AeoBotTrafficFilter": ".types",
+ "AeoBotTrafficPage": ".types",
+ "AeoBotTrafficPagesResponse": ".types",
+ "AeoBotTrafficResponse": ".types",
+ "AeoBrandNames": ".types",
+ "AeoCitationFilter": ".types",
+ "AeoCitationRateResponse": ".types",
+ "AeoCitationRateResponseBreakdown": ".types",
+ "AeoCitationRateResponseDataItem": ".types",
+ "AeoCitationsResponse": ".types",
+ "AeoCitationsResponseDataItem": ".types",
+ "AeoCitedDomainPathsResponse": ".types",
+ "AeoCitedPath": ".types",
+ "AeoCompetitorCitationsResponse": ".types",
+ "AeoCompetitorCitationsResponseDataItem": ".types",
+ "AeoOwnedCitedPath": ".types",
+ "AeoPage": ".types",
+ "AeoPageCitationShareResponse": ".types",
+ "AeoPageCitationShareResponseDataItem": ".types",
+ "AeoPageCitationShareResponseFilter": ".types",
+ "AeoPageCitationShareResponsePage": ".types",
+ "AeoPrompt": ".types",
+ "AeoPromptExecution": ".types",
+ "AeoPromptExecutionListResponse": ".types",
+ "AeoPromptExecutionPromptStatus": ".types",
+ "AeoPromptExecutionStatus": ".types",
+ "AeoPromptExecutionTopic": ".types",
+ "AeoPromptIdsFilter": ".types",
+ "AeoPromptLabel": ".types",
+ "AeoPromptListResponse": ".types",
+ "AeoPromptStatus": ".types",
+ "AeoPromptTopic": ".types",
+ "AeoTimeseries": ".types",
+ "AeoTimeseriesGranularityPeriod": ".types",
+ "AeoTopCitedDomainsResponse": ".types",
+ "AeoTopCitedDomainsResponseDataItem": ".types",
+ "AeoTopicEngineFilter": ".types",
+ "AeoTopicIdsFilter": ".types",
+ "AeoTopicLabel": ".types",
+ "AeoVisibilityBreakdownResponse": ".types",
+ "AeoVisibilityBreakdownResponseBreakdown": ".types",
+ "AeoVisibilityBreakdownResponseDataItem": ".types",
+ "AeoVisibilityFilter": ".types",
+ "AeoVisibilityResponse": ".types",
+ "AeoVisibilityResponseDataItem": ".types",
+ "AeoVisibilityScore": ".types",
+ "AeoWindow": ".types",
+ "AnalyzeBucketTimeZone": ".types",
+ "AnalyzeDailyBucketing": ".types",
+ "AnalyzeDailyTimeseriesQuery": ".types",
+ "AnalyzeFilterOperators": ".types",
+ "AnalyzeTimeOnPageBucketing": ".types",
+ "AnalyzeWindow": ".types",
"Application": ".types",
"Asset": ".types",
"AssetFolder": ".types",
@@ -335,8 +631,18 @@
"AuthorizedUser": ".types",
"BadRequestError": ".errors",
"BadRequestErrorBody": ".types",
+ "BranchCreatedWebhook": ".types",
+ "BranchCreatedWebhookPayload": ".types",
+ "BranchDeletedWebhook": ".types",
+ "BranchDeletedWebhookPayload": ".types",
+ "BranchMergedWebhook": ".types",
+ "BranchMergedWebhookPayload": ".types",
+ "BrowserWindowHeightDataPoint": ".types",
+ "BrowserWindowHeightFilter": ".types",
+ "BrowserWindowHeightResponse": ".types",
"BulkCollectionItem": ".types",
"BulkCollectionItemFieldData": ".types",
+ "CollaboratorClientInvite": ".types",
"Collection": ".types",
"CollectionItem": ".types",
"CollectionItemChanged": ".types",
@@ -364,6 +670,7 @@
"CommentPayload": ".types",
"CommentPayloadAuthor": ".types",
"CommentPayloadMentionedUsersItem": ".types",
+ "CommentPayloadType": ".types",
"CommentReply": ".types",
"CommentReplyAuthor": ".types",
"CommentReplyList": ".types",
@@ -384,7 +691,8 @@
"ComponentProperties": ".types",
"ComponentPropertiesWritePropertiesItem": ".resources",
"ComponentProperty": ".types",
- "ComponentPropertyType": ".types",
+ "ComponentPropertyText": ".types",
+ "ComponentPropertyTextType": ".types",
"ComponentsUpdateContentResponse": ".resources",
"ComponentsUpdatePropertiesResponse": ".resources",
"Conflict": ".types",
@@ -393,6 +701,27 @@
"CustomCodeBlockType": ".types",
"CustomCodeHostedResponse": ".types",
"CustomCodeInlineResponse": ".types",
+ "CustomFont": ".types",
+ "CustomFontAxis": ".types",
+ "CustomFontBatchCreateRequestItemsItem": ".resources",
+ "CustomFontBatchCreateRequestItemsItemFontDisplay": ".resources",
+ "CustomFontBatchCreateResponse": ".types",
+ "CustomFontBatchCreateResponseCreatedItem": ".types",
+ "CustomFontBatchCreateResponseFailedItem": ".types",
+ "CustomFontBatchDeleteRequestItemsItem": ".resources",
+ "CustomFontBatchDeleteResponse": ".types",
+ "CustomFontBatchDeleteResponseDeletedItem": ".types",
+ "CustomFontBatchDeleteResponseFailedItem": ".types",
+ "CustomFontCreateResponse": ".types",
+ "CustomFontFontDisplay": ".types",
+ "CustomFontFormat": ".types",
+ "CustomFontUpload": ".types",
+ "CustomFontUploadFields": ".types",
+ "CustomFonts": ".types",
+ "CustomFontsCreateRequestFontDisplay": ".resources",
+ "CustomFontsGetResponse": ".resources",
+ "CustomFontsUpdateRequestFontDisplay": ".resources",
+ "CustomFontsUpdateResponse": ".resources",
"CustomRole": ".types",
"CustomRoleAuditLogItem": ".types",
"CustomRoleAuditLogItemEventSubType": ".types",
@@ -405,10 +734,10 @@
"ErrorCode": ".types",
"Field": ".types",
"FieldCreate": ".types",
+ "FieldGroup": ".types",
"FieldType": ".types",
"FieldValidations": ".types",
"FieldValidationsAdditionalProperties": ".types",
- "FieldValidationsAdditionalPropertiesAdditionalProperties": ".types",
"ForbiddenError": ".errors",
"ForbiddenErrorBody": ".types",
"Form": ".types",
@@ -423,16 +752,49 @@
"FormSubmissionTriggerPayload": ".types",
"FormSubmissionTriggerPayloadSchemaItem": ".types",
"FormSubmissionTriggerPayloadSchemaItemFieldType": ".types",
+ "Goal": ".types",
+ "GoalCategory": ".types",
+ "GoalIntegrationSource": ".types",
+ "GoalPerformanceDataPoint": ".types",
+ "GoalPerformanceFilter": ".types",
+ "GoalPerformanceResponse": ".types",
+ "GoalScope": ".types",
+ "GoalType": ".types",
+ "GoalValueType": ".types",
+ "GoalsResponse": ".types",
+ "GoogleTagId": ".types",
+ "GoogleTagIds": ".types",
"ImageNode": ".types",
"ImageNodeImage": ".types",
+ "InsertCollectionItem": ".types",
+ "InsertCollectionItemFieldData": ".types",
+ "InsertedCollectionItem": ".types",
+ "InsertedCollectionItemFieldData": ".types",
"InternalServerError": ".errors",
"InvalidDomain": ".types",
"InvalidScopes": ".types",
"InventoryItem": ".types",
"InventoryItemInventoryType": ".types",
"InventoryUpdateRequestInventoryType": ".resources",
+ "InviteWorkspaceMemberRequestBody": ".types",
+ "InviteWorkspaceMemberRequestBodyDefaultSiteRoleDefaultSiteRole": ".types",
+ "InviteWorkspaceMemberRequestBodyDefaultSiteRoleWorkspaceRole": ".types",
+ "InviteWorkspaceMemberRequestBodyEmailSiteAccessItem": ".types",
+ "InviteWorkspaceMemberRequestBodyEmailSiteAccessItemSiteRole": ".types",
+ "InviteWorkspaceMemberRequestBodyOneSiteAccessItem": ".types",
+ "InviteWorkspaceMemberRequestBodyOneSiteAccessItemSiteRole": ".types",
+ "InviteWorkspaceMemberRequestBodyOneWorkspaceRole": ".types",
+ "InviteWorkspaceMemberResponseBody": ".types",
+ "InviteWorkspaceMemberResponseBodyActive": ".types",
+ "InviteWorkspaceMemberResponseBody_Active": ".types",
+ "InviteWorkspaceMemberResponseBody_Invited": ".types",
+ "Invited": ".types",
+ "ItemsListItemsLiveRequestCreatedOn": ".types",
"ItemsListItemsLiveRequestLastPublished": ".types",
+ "ItemsListItemsLiveRequestLastUpdated": ".types",
+ "ItemsListItemsRequestCreatedOn": ".types",
"ItemsListItemsRequestLastPublished": ".types",
+ "ItemsListItemsRequestLastUpdated": ".types",
"ListCustomCodeBlocks": ".types",
"Locale": ".types",
"Locales": ".types",
@@ -451,6 +813,46 @@
"NotEnterprisePlanSite": ".types",
"NotEnterprisePlanWorkspace": ".types",
"NotFoundError": ".errors",
+ "Optimization": ".types",
+ "OptimizationAudienceInsightsResponse": ".types",
+ "OptimizationDimensionValuesResponse": ".types",
+ "OptimizationDimensionsResponse": ".types",
+ "OptimizationGoalsResponse": ".types",
+ "OptimizationInterval": ".types",
+ "OptimizationListResponse": ".types",
+ "OptimizationStatus": ".types",
+ "OptimizationSummaryResponse": ".types",
+ "OptimizationTrendResponse": ".types",
+ "OptimizationType": ".types",
+ "OptimizeAppliedFilter": ".types",
+ "OptimizeAppliedFilterEntry": ".types",
+ "OptimizeAudienceSegment": ".types",
+ "OptimizeAudienceVariation": ".types",
+ "OptimizeCurrentGoal": ".types",
+ "OptimizeDimension": ".types",
+ "OptimizeDimensionValue": ".types",
+ "OptimizeFilter": ".types",
+ "OptimizeFilterOperators": ".types",
+ "OptimizeGoal": ".types",
+ "OptimizeGoalCountingMethod": ".types",
+ "OptimizeGoalMetricType": ".types",
+ "OptimizeGoalScope": ".types",
+ "OptimizeGoalSource": ".types",
+ "OptimizeNonWebflowSiteResource": ".types",
+ "OptimizeReference": ".types",
+ "OptimizeReferenceListResponse": ".types",
+ "OptimizeReferenceResource": ".types",
+ "OptimizeReferenceResource_OptimizeSite": ".types",
+ "OptimizeReferenceResource_WebflowSite": ".types",
+ "OptimizeReportGoal": ".types",
+ "OptimizeReportIntervalEnd": ".types",
+ "OptimizeReportIntervalStart": ".types",
+ "OptimizeTrendDirection": ".types",
+ "OptimizeTrendGranularity": ".types",
+ "OptimizeTrendPoint": ".types",
+ "OptimizeVariationComparison": ".types",
+ "OptimizeVariationResult": ".types",
+ "OptimizeWebflowSiteResource": ".types",
"OptionField": ".types",
"Order": ".types",
"OrderAddress": ".types",
@@ -484,6 +886,11 @@
"PageDeletedWebhook": ".types",
"PageDeletedWebhookPayload": ".types",
"PageDomWriteNodesItem": ".resources",
+ "PageFlowDirection": ".types",
+ "PageFlowFilter": ".types",
+ "PageFlowMetricScope": ".types",
+ "PageFlowResponse": ".types",
+ "PageFlowRow": ".types",
"PageList": ".types",
"PageMetadataUpdatedWebhook": ".types",
"PageMetadataUpdatedWebhookPayload": ".types",
@@ -495,6 +902,7 @@
"Payload": ".types",
"PayloadFieldData": ".types",
"PaypalDetails": ".types",
+ "PersonActor": ".types",
"Product": ".types",
"ProductAndSkUs": ".types",
"ProductAndSkUsList": ".types",
@@ -517,23 +925,35 @@
"ScriptApplyList": ".types",
"ScriptApplyLocation": ".types",
"Scripts": ".types",
+ "ScrollDepthDataPoint": ".types",
+ "ScrollDepthFilter": ".types",
+ "ScrollDepthResponse": ".types",
"SearchButtonNode": ".types",
"SearchButtonNodeWrite": ".types",
"Select": ".types",
"SelectNode": ".types",
"SelectNodeChoicesItem": ".types",
"SelectNodeWriteChoicesItem": ".types",
+ "ServiceUnavailableError": ".errors",
"SettingChange": ".types",
"SettingChangeAuditLogItem": ".types",
"SingleLocaleCreatedPayload": ".types",
"SingleLocaleCreatedPayloadFieldData": ".types",
"Site": ".types",
"SiteActivityLogItem": ".types",
+ "SiteActivityLogItemActorType": ".types",
"SiteActivityLogItemEvent": ".types",
"SiteActivityLogItemResourceOperation": ".types",
+ "SiteActivityLogItemSource": ".types",
"SiteActivityLogItemUser": ".types",
"SiteActivityLogResponse": ".types",
"SiteDataCollectionType": ".types",
+ "SiteMember": ".types",
+ "SiteMemberRoles": ".types",
+ "SiteMemberRolesSite": ".types",
+ "SiteMemberRolesWorkspace": ".types",
+ "SiteMembersResponse": ".types",
+ "SiteMembersResponsePagination": ".types",
"SiteMembership": ".types",
"SiteMembershipAuditLogItem": ".types",
"SiteMembershipAuditLogItemEventSubType": ".types",
@@ -542,8 +962,10 @@
"SitePlanName": ".types",
"SitePublish": ".types",
"SitePublishPayload": ".types",
+ "SitePublishPayloadPublishScope": ".types",
"Sites": ".types",
"SitesPublishResponse": ".resources",
+ "SitesPublishResponsePublishScope": ".resources",
"Sku": ".types",
"SkuFieldData": ".types",
"SkuFieldDataCompareAtPrice": ".types",
@@ -570,9 +992,38 @@
"TextNode": ".types",
"TextNodeText": ".types",
"TextNodeWrite": ".types",
+ "TimeOnPageDataPoint": ".types",
+ "TimeOnPageFilter": ".types",
+ "TimeOnPageGranularityPeriod": ".types",
+ "TimeOnPageMetricScope": ".types",
+ "TimeOnPageResponse": ".types",
+ "TimeOnPageTimeseriesQuery": ".types",
+ "TokenActor": ".types",
"TooManyRequestsError": ".errors",
+ "TopDimensionsDimension": ".types",
+ "TopDimensionsFilter": ".types",
+ "TopDimensionsMetricScope": ".types",
+ "TopDimensionsResponse": ".types",
+ "TopDimensionsRow": ".types",
+ "TopEventsCmsContextEntry": ".types",
+ "TopEventsComponentContextEntry": ".types",
+ "TopEventsFilter": ".types",
+ "TopEventsResponse": ".types",
+ "TopEventsRow": ".types",
+ "TopEventsTimeseriesPoint": ".types",
+ "TopPagesFilter": ".types",
+ "TopPagesResponse": ".types",
+ "TopPagesRow": ".types",
+ "TopPagesSortBy": ".types",
+ "TopPagesTimeseriesPoint": ".types",
+ "TrafficDataPoint": ".types",
+ "TrafficFilter": ".types",
+ "TrafficMetricScope": ".types",
+ "TrafficResponse": ".types",
"TriggerType": ".types",
"UnauthorizedError": ".errors",
+ "UpdateSiteMemberRoleRequestBody": ".types",
+ "UpdateSiteMemberRoleRequestBodySiteRole": ".types",
"UpdateStaticContentResponse": ".resources",
"UpdatedOrder": ".types",
"UserAccess": ".types",
@@ -583,9 +1034,13 @@
"Webhook": ".types",
"WebhookFilter": ".types",
"WebhookList": ".types",
+ "WithDefaultSiteRole": ".types",
+ "WithSiteAccess": ".types",
+ "Workspace": ".types",
+ "WorkspaceAuditLogActor": ".types",
+ "WorkspaceAuditLogActor_Person": ".types",
+ "WorkspaceAuditLogActor_Token": ".types",
"WorkspaceAuditLogItem": ".types",
- "WorkspaceAuditLogItemActor": ".types",
- "WorkspaceAuditLogItemPayloadSettingChangeMethod": ".types",
"WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess": ".types",
"WorkspaceAuditLogItemPayloadSiteMembershipMethod": ".types",
"WorkspaceAuditLogItemPayloadSiteMembershipSite": ".types",
@@ -607,19 +1062,40 @@
"WorkspaceAuditLogItem_WorkspaceMembership": ".types",
"WorkspaceAuditLogItem_WorkspaceSetting": ".types",
"WorkspaceAuditLogResponse": ".types",
+ "WorkspaceBulkRoleChangeResponse": ".types",
+ "WorkspaceBulkRoleChangeResponseResultsItem": ".types",
+ "WorkspaceBulkRoleChangeResponseResultsItemError": ".types",
+ "WorkspaceBulkRoleChangeResponseResultsItemErrorCode": ".types",
+ "WorkspaceBulkRoleChangeResponseResultsItemOutcome": ".types",
+ "WorkspaceBulkRoleChangeResponseResultsItemType": ".types",
+ "WorkspaceBulkRoleChangeResponseSummary": ".types",
"WorkspaceInvitation": ".types",
"WorkspaceInvitationAuditLogItem": ".types",
"WorkspaceInvitationAuditLogItemEventSubType": ".types",
+ "WorkspaceInvite": ".types",
+ "WorkspaceInviteDefaultSiteRole": ".types",
+ "WorkspaceInviteRole": ".types",
+ "WorkspaceInviteStatus": ".types",
+ "WorkspaceMember": ".types",
+ "WorkspaceMemberRoles": ".types",
+ "WorkspaceMemberRolesSite": ".types",
+ "WorkspaceMemberRolesWorkspace": ".types",
+ "WorkspaceMembersResponse": ".types",
+ "WorkspaceMembersResponsePagination": ".types",
"WorkspaceMembership": ".types",
"WorkspaceMembershipAuditLogItem": ".types",
"WorkspaceMembershipAuditLogItemEventSubType": ".types",
+ "Workspaces": ".types",
"__version__": ".version",
+ "analyze": ".resources",
"assets": ".resources",
"collections": ".resources",
"components": ".resources",
+ "custom_fonts": ".resources",
"ecommerce": ".resources",
"forms": ".resources",
"inventory": ".resources",
+ "optimize": ".resources",
"orders": ".resources",
"pages": ".resources",
"products": ".resources",
@@ -653,6 +1129,64 @@ def __dir__():
__all__ = [
+ "AeoAnswerEngine",
+ "AeoAnswerEngineKey",
+ "AeoAnswerEnginesFilter",
+ "AeoBotCategory",
+ "AeoBotProvider",
+ "AeoBotTrafficFilter",
+ "AeoBotTrafficPage",
+ "AeoBotTrafficPagesResponse",
+ "AeoBotTrafficResponse",
+ "AeoBrandNames",
+ "AeoCitationFilter",
+ "AeoCitationRateResponse",
+ "AeoCitationRateResponseBreakdown",
+ "AeoCitationRateResponseDataItem",
+ "AeoCitationsResponse",
+ "AeoCitationsResponseDataItem",
+ "AeoCitedDomainPathsResponse",
+ "AeoCitedPath",
+ "AeoCompetitorCitationsResponse",
+ "AeoCompetitorCitationsResponseDataItem",
+ "AeoOwnedCitedPath",
+ "AeoPage",
+ "AeoPageCitationShareResponse",
+ "AeoPageCitationShareResponseDataItem",
+ "AeoPageCitationShareResponseFilter",
+ "AeoPageCitationShareResponsePage",
+ "AeoPrompt",
+ "AeoPromptExecution",
+ "AeoPromptExecutionListResponse",
+ "AeoPromptExecutionPromptStatus",
+ "AeoPromptExecutionStatus",
+ "AeoPromptExecutionTopic",
+ "AeoPromptIdsFilter",
+ "AeoPromptLabel",
+ "AeoPromptListResponse",
+ "AeoPromptStatus",
+ "AeoPromptTopic",
+ "AeoTimeseries",
+ "AeoTimeseriesGranularityPeriod",
+ "AeoTopCitedDomainsResponse",
+ "AeoTopCitedDomainsResponseDataItem",
+ "AeoTopicEngineFilter",
+ "AeoTopicIdsFilter",
+ "AeoTopicLabel",
+ "AeoVisibilityBreakdownResponse",
+ "AeoVisibilityBreakdownResponseBreakdown",
+ "AeoVisibilityBreakdownResponseDataItem",
+ "AeoVisibilityFilter",
+ "AeoVisibilityResponse",
+ "AeoVisibilityResponseDataItem",
+ "AeoVisibilityScore",
+ "AeoWindow",
+ "AnalyzeBucketTimeZone",
+ "AnalyzeDailyBucketing",
+ "AnalyzeDailyTimeseriesQuery",
+ "AnalyzeFilterOperators",
+ "AnalyzeTimeOnPageBucketing",
+ "AnalyzeWindow",
"Application",
"Asset",
"AssetFolder",
@@ -668,8 +1202,18 @@ def __dir__():
"AuthorizedUser",
"BadRequestError",
"BadRequestErrorBody",
+ "BranchCreatedWebhook",
+ "BranchCreatedWebhookPayload",
+ "BranchDeletedWebhook",
+ "BranchDeletedWebhookPayload",
+ "BranchMergedWebhook",
+ "BranchMergedWebhookPayload",
+ "BrowserWindowHeightDataPoint",
+ "BrowserWindowHeightFilter",
+ "BrowserWindowHeightResponse",
"BulkCollectionItem",
"BulkCollectionItemFieldData",
+ "CollaboratorClientInvite",
"Collection",
"CollectionItem",
"CollectionItemChanged",
@@ -697,6 +1241,7 @@ def __dir__():
"CommentPayload",
"CommentPayloadAuthor",
"CommentPayloadMentionedUsersItem",
+ "CommentPayloadType",
"CommentReply",
"CommentReplyAuthor",
"CommentReplyList",
@@ -717,7 +1262,8 @@ def __dir__():
"ComponentProperties",
"ComponentPropertiesWritePropertiesItem",
"ComponentProperty",
- "ComponentPropertyType",
+ "ComponentPropertyText",
+ "ComponentPropertyTextType",
"ComponentsUpdateContentResponse",
"ComponentsUpdatePropertiesResponse",
"Conflict",
@@ -726,6 +1272,27 @@ def __dir__():
"CustomCodeBlockType",
"CustomCodeHostedResponse",
"CustomCodeInlineResponse",
+ "CustomFont",
+ "CustomFontAxis",
+ "CustomFontBatchCreateRequestItemsItem",
+ "CustomFontBatchCreateRequestItemsItemFontDisplay",
+ "CustomFontBatchCreateResponse",
+ "CustomFontBatchCreateResponseCreatedItem",
+ "CustomFontBatchCreateResponseFailedItem",
+ "CustomFontBatchDeleteRequestItemsItem",
+ "CustomFontBatchDeleteResponse",
+ "CustomFontBatchDeleteResponseDeletedItem",
+ "CustomFontBatchDeleteResponseFailedItem",
+ "CustomFontCreateResponse",
+ "CustomFontFontDisplay",
+ "CustomFontFormat",
+ "CustomFontUpload",
+ "CustomFontUploadFields",
+ "CustomFonts",
+ "CustomFontsCreateRequestFontDisplay",
+ "CustomFontsGetResponse",
+ "CustomFontsUpdateRequestFontDisplay",
+ "CustomFontsUpdateResponse",
"CustomRole",
"CustomRoleAuditLogItem",
"CustomRoleAuditLogItemEventSubType",
@@ -738,10 +1305,10 @@ def __dir__():
"ErrorCode",
"Field",
"FieldCreate",
+ "FieldGroup",
"FieldType",
"FieldValidations",
"FieldValidationsAdditionalProperties",
- "FieldValidationsAdditionalPropertiesAdditionalProperties",
"ForbiddenError",
"ForbiddenErrorBody",
"Form",
@@ -756,16 +1323,49 @@ def __dir__():
"FormSubmissionTriggerPayload",
"FormSubmissionTriggerPayloadSchemaItem",
"FormSubmissionTriggerPayloadSchemaItemFieldType",
+ "Goal",
+ "GoalCategory",
+ "GoalIntegrationSource",
+ "GoalPerformanceDataPoint",
+ "GoalPerformanceFilter",
+ "GoalPerformanceResponse",
+ "GoalScope",
+ "GoalType",
+ "GoalValueType",
+ "GoalsResponse",
+ "GoogleTagId",
+ "GoogleTagIds",
"ImageNode",
"ImageNodeImage",
+ "InsertCollectionItem",
+ "InsertCollectionItemFieldData",
+ "InsertedCollectionItem",
+ "InsertedCollectionItemFieldData",
"InternalServerError",
"InvalidDomain",
"InvalidScopes",
"InventoryItem",
"InventoryItemInventoryType",
"InventoryUpdateRequestInventoryType",
+ "InviteWorkspaceMemberRequestBody",
+ "InviteWorkspaceMemberRequestBodyDefaultSiteRoleDefaultSiteRole",
+ "InviteWorkspaceMemberRequestBodyDefaultSiteRoleWorkspaceRole",
+ "InviteWorkspaceMemberRequestBodyEmailSiteAccessItem",
+ "InviteWorkspaceMemberRequestBodyEmailSiteAccessItemSiteRole",
+ "InviteWorkspaceMemberRequestBodyOneSiteAccessItem",
+ "InviteWorkspaceMemberRequestBodyOneSiteAccessItemSiteRole",
+ "InviteWorkspaceMemberRequestBodyOneWorkspaceRole",
+ "InviteWorkspaceMemberResponseBody",
+ "InviteWorkspaceMemberResponseBodyActive",
+ "InviteWorkspaceMemberResponseBody_Active",
+ "InviteWorkspaceMemberResponseBody_Invited",
+ "Invited",
+ "ItemsListItemsLiveRequestCreatedOn",
"ItemsListItemsLiveRequestLastPublished",
+ "ItemsListItemsLiveRequestLastUpdated",
+ "ItemsListItemsRequestCreatedOn",
"ItemsListItemsRequestLastPublished",
+ "ItemsListItemsRequestLastUpdated",
"ListCustomCodeBlocks",
"Locale",
"Locales",
@@ -784,6 +1384,46 @@ def __dir__():
"NotEnterprisePlanSite",
"NotEnterprisePlanWorkspace",
"NotFoundError",
+ "Optimization",
+ "OptimizationAudienceInsightsResponse",
+ "OptimizationDimensionValuesResponse",
+ "OptimizationDimensionsResponse",
+ "OptimizationGoalsResponse",
+ "OptimizationInterval",
+ "OptimizationListResponse",
+ "OptimizationStatus",
+ "OptimizationSummaryResponse",
+ "OptimizationTrendResponse",
+ "OptimizationType",
+ "OptimizeAppliedFilter",
+ "OptimizeAppliedFilterEntry",
+ "OptimizeAudienceSegment",
+ "OptimizeAudienceVariation",
+ "OptimizeCurrentGoal",
+ "OptimizeDimension",
+ "OptimizeDimensionValue",
+ "OptimizeFilter",
+ "OptimizeFilterOperators",
+ "OptimizeGoal",
+ "OptimizeGoalCountingMethod",
+ "OptimizeGoalMetricType",
+ "OptimizeGoalScope",
+ "OptimizeGoalSource",
+ "OptimizeNonWebflowSiteResource",
+ "OptimizeReference",
+ "OptimizeReferenceListResponse",
+ "OptimizeReferenceResource",
+ "OptimizeReferenceResource_OptimizeSite",
+ "OptimizeReferenceResource_WebflowSite",
+ "OptimizeReportGoal",
+ "OptimizeReportIntervalEnd",
+ "OptimizeReportIntervalStart",
+ "OptimizeTrendDirection",
+ "OptimizeTrendGranularity",
+ "OptimizeTrendPoint",
+ "OptimizeVariationComparison",
+ "OptimizeVariationResult",
+ "OptimizeWebflowSiteResource",
"OptionField",
"Order",
"OrderAddress",
@@ -817,6 +1457,11 @@ def __dir__():
"PageDeletedWebhook",
"PageDeletedWebhookPayload",
"PageDomWriteNodesItem",
+ "PageFlowDirection",
+ "PageFlowFilter",
+ "PageFlowMetricScope",
+ "PageFlowResponse",
+ "PageFlowRow",
"PageList",
"PageMetadataUpdatedWebhook",
"PageMetadataUpdatedWebhookPayload",
@@ -828,6 +1473,7 @@ def __dir__():
"Payload",
"PayloadFieldData",
"PaypalDetails",
+ "PersonActor",
"Product",
"ProductAndSkUs",
"ProductAndSkUsList",
@@ -850,23 +1496,35 @@ def __dir__():
"ScriptApplyList",
"ScriptApplyLocation",
"Scripts",
+ "ScrollDepthDataPoint",
+ "ScrollDepthFilter",
+ "ScrollDepthResponse",
"SearchButtonNode",
"SearchButtonNodeWrite",
"Select",
"SelectNode",
"SelectNodeChoicesItem",
"SelectNodeWriteChoicesItem",
+ "ServiceUnavailableError",
"SettingChange",
"SettingChangeAuditLogItem",
"SingleLocaleCreatedPayload",
"SingleLocaleCreatedPayloadFieldData",
"Site",
"SiteActivityLogItem",
+ "SiteActivityLogItemActorType",
"SiteActivityLogItemEvent",
"SiteActivityLogItemResourceOperation",
+ "SiteActivityLogItemSource",
"SiteActivityLogItemUser",
"SiteActivityLogResponse",
"SiteDataCollectionType",
+ "SiteMember",
+ "SiteMemberRoles",
+ "SiteMemberRolesSite",
+ "SiteMemberRolesWorkspace",
+ "SiteMembersResponse",
+ "SiteMembersResponsePagination",
"SiteMembership",
"SiteMembershipAuditLogItem",
"SiteMembershipAuditLogItemEventSubType",
@@ -875,8 +1533,10 @@ def __dir__():
"SitePlanName",
"SitePublish",
"SitePublishPayload",
+ "SitePublishPayloadPublishScope",
"Sites",
"SitesPublishResponse",
+ "SitesPublishResponsePublishScope",
"Sku",
"SkuFieldData",
"SkuFieldDataCompareAtPrice",
@@ -903,9 +1563,38 @@ def __dir__():
"TextNode",
"TextNodeText",
"TextNodeWrite",
+ "TimeOnPageDataPoint",
+ "TimeOnPageFilter",
+ "TimeOnPageGranularityPeriod",
+ "TimeOnPageMetricScope",
+ "TimeOnPageResponse",
+ "TimeOnPageTimeseriesQuery",
+ "TokenActor",
"TooManyRequestsError",
+ "TopDimensionsDimension",
+ "TopDimensionsFilter",
+ "TopDimensionsMetricScope",
+ "TopDimensionsResponse",
+ "TopDimensionsRow",
+ "TopEventsCmsContextEntry",
+ "TopEventsComponentContextEntry",
+ "TopEventsFilter",
+ "TopEventsResponse",
+ "TopEventsRow",
+ "TopEventsTimeseriesPoint",
+ "TopPagesFilter",
+ "TopPagesResponse",
+ "TopPagesRow",
+ "TopPagesSortBy",
+ "TopPagesTimeseriesPoint",
+ "TrafficDataPoint",
+ "TrafficFilter",
+ "TrafficMetricScope",
+ "TrafficResponse",
"TriggerType",
"UnauthorizedError",
+ "UpdateSiteMemberRoleRequestBody",
+ "UpdateSiteMemberRoleRequestBodySiteRole",
"UpdateStaticContentResponse",
"UpdatedOrder",
"UserAccess",
@@ -916,9 +1605,13 @@ def __dir__():
"Webhook",
"WebhookFilter",
"WebhookList",
+ "WithDefaultSiteRole",
+ "WithSiteAccess",
+ "Workspace",
+ "WorkspaceAuditLogActor",
+ "WorkspaceAuditLogActor_Person",
+ "WorkspaceAuditLogActor_Token",
"WorkspaceAuditLogItem",
- "WorkspaceAuditLogItemActor",
- "WorkspaceAuditLogItemPayloadSettingChangeMethod",
"WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess",
"WorkspaceAuditLogItemPayloadSiteMembershipMethod",
"WorkspaceAuditLogItemPayloadSiteMembershipSite",
@@ -940,19 +1633,40 @@ def __dir__():
"WorkspaceAuditLogItem_WorkspaceMembership",
"WorkspaceAuditLogItem_WorkspaceSetting",
"WorkspaceAuditLogResponse",
+ "WorkspaceBulkRoleChangeResponse",
+ "WorkspaceBulkRoleChangeResponseResultsItem",
+ "WorkspaceBulkRoleChangeResponseResultsItemError",
+ "WorkspaceBulkRoleChangeResponseResultsItemErrorCode",
+ "WorkspaceBulkRoleChangeResponseResultsItemOutcome",
+ "WorkspaceBulkRoleChangeResponseResultsItemType",
+ "WorkspaceBulkRoleChangeResponseSummary",
"WorkspaceInvitation",
"WorkspaceInvitationAuditLogItem",
"WorkspaceInvitationAuditLogItemEventSubType",
+ "WorkspaceInvite",
+ "WorkspaceInviteDefaultSiteRole",
+ "WorkspaceInviteRole",
+ "WorkspaceInviteStatus",
+ "WorkspaceMember",
+ "WorkspaceMemberRoles",
+ "WorkspaceMemberRolesSite",
+ "WorkspaceMemberRolesWorkspace",
+ "WorkspaceMembersResponse",
+ "WorkspaceMembersResponsePagination",
"WorkspaceMembership",
"WorkspaceMembershipAuditLogItem",
"WorkspaceMembershipAuditLogItemEventSubType",
+ "Workspaces",
"__version__",
+ "analyze",
"assets",
"collections",
"components",
+ "custom_fonts",
"ecommerce",
"forms",
"inventory",
+ "optimize",
"orders",
"pages",
"products",
diff --git a/src/webflow/client.py b/src/webflow/client.py
index bc75156d..99e27bc5 100644
--- a/src/webflow/client.py
+++ b/src/webflow/client.py
@@ -10,12 +10,15 @@
from .environment import WebflowEnvironment
if typing.TYPE_CHECKING:
+ from .resources.analyze.client import AnalyzeClient, AsyncAnalyzeClient
from .resources.assets.client import AssetsClient, AsyncAssetsClient
from .resources.collections.client import AsyncCollectionsClient, CollectionsClient
from .resources.components.client import AsyncComponentsClient, ComponentsClient
+ from .resources.custom_fonts.client import AsyncCustomFontsClient, CustomFontsClient
from .resources.ecommerce.client import AsyncEcommerceClient, EcommerceClient
from .resources.forms.client import AsyncFormsClient, FormsClient
from .resources.inventory.client import AsyncInventoryClient, InventoryClient
+ from .resources.optimize.client import AsyncOptimizeClient, OptimizeClient
from .resources.orders.client import AsyncOrdersClient, OrdersClient
from .resources.pages.client import AsyncPagesClient, PagesClient
from .resources.products.client import AsyncProductsClient, ProductsClient
@@ -93,19 +96,22 @@ def __init__(
logging=logging,
)
self._token: typing.Optional[TokenClient] = None
+ self._workspaces: typing.Optional[WorkspacesClient] = None
self._sites: typing.Optional[SitesClient] = None
+ self._optimize: typing.Optional[OptimizeClient] = None
self._collections: typing.Optional[CollectionsClient] = None
self._pages: typing.Optional[PagesClient] = None
self._components: typing.Optional[ComponentsClient] = None
self._scripts: typing.Optional[ScriptsClient] = None
self._assets: typing.Optional[AssetsClient] = None
+ self._custom_fonts: typing.Optional[CustomFontsClient] = None
self._webhooks: typing.Optional[WebhooksClient] = None
self._forms: typing.Optional[FormsClient] = None
self._products: typing.Optional[ProductsClient] = None
self._orders: typing.Optional[OrdersClient] = None
self._inventory: typing.Optional[InventoryClient] = None
self._ecommerce: typing.Optional[EcommerceClient] = None
- self._workspaces: typing.Optional[WorkspacesClient] = None
+ self._analyze: typing.Optional[AnalyzeClient] = None
@property
def token(self):
@@ -115,6 +121,14 @@ def token(self):
self._token = TokenClient(client_wrapper=self._client_wrapper)
return self._token
+ @property
+ def workspaces(self):
+ if self._workspaces is None:
+ from .resources.workspaces.client import WorkspacesClient # noqa: E402
+
+ self._workspaces = WorkspacesClient(client_wrapper=self._client_wrapper)
+ return self._workspaces
+
@property
def sites(self):
if self._sites is None:
@@ -123,6 +137,14 @@ def sites(self):
self._sites = SitesClient(client_wrapper=self._client_wrapper)
return self._sites
+ @property
+ def optimize(self):
+ if self._optimize is None:
+ from .resources.optimize.client import OptimizeClient # noqa: E402
+
+ self._optimize = OptimizeClient(client_wrapper=self._client_wrapper)
+ return self._optimize
+
@property
def collections(self):
if self._collections is None:
@@ -163,6 +185,14 @@ def assets(self):
self._assets = AssetsClient(client_wrapper=self._client_wrapper)
return self._assets
+ @property
+ def custom_fonts(self):
+ if self._custom_fonts is None:
+ from .resources.custom_fonts.client import CustomFontsClient # noqa: E402
+
+ self._custom_fonts = CustomFontsClient(client_wrapper=self._client_wrapper)
+ return self._custom_fonts
+
@property
def webhooks(self):
if self._webhooks is None:
@@ -212,12 +242,12 @@ def ecommerce(self):
return self._ecommerce
@property
- def workspaces(self):
- if self._workspaces is None:
- from .resources.workspaces.client import WorkspacesClient # noqa: E402
+ def analyze(self):
+ if self._analyze is None:
+ from .resources.analyze.client import AnalyzeClient # noqa: E402
- self._workspaces = WorkspacesClient(client_wrapper=self._client_wrapper)
- return self._workspaces
+ self._analyze = AnalyzeClient(client_wrapper=self._client_wrapper)
+ return self._analyze
class AsyncWebflow:
@@ -287,19 +317,22 @@ def __init__(
logging=logging,
)
self._token: typing.Optional[AsyncTokenClient] = None
+ self._workspaces: typing.Optional[AsyncWorkspacesClient] = None
self._sites: typing.Optional[AsyncSitesClient] = None
+ self._optimize: typing.Optional[AsyncOptimizeClient] = None
self._collections: typing.Optional[AsyncCollectionsClient] = None
self._pages: typing.Optional[AsyncPagesClient] = None
self._components: typing.Optional[AsyncComponentsClient] = None
self._scripts: typing.Optional[AsyncScriptsClient] = None
self._assets: typing.Optional[AsyncAssetsClient] = None
+ self._custom_fonts: typing.Optional[AsyncCustomFontsClient] = None
self._webhooks: typing.Optional[AsyncWebhooksClient] = None
self._forms: typing.Optional[AsyncFormsClient] = None
self._products: typing.Optional[AsyncProductsClient] = None
self._orders: typing.Optional[AsyncOrdersClient] = None
self._inventory: typing.Optional[AsyncInventoryClient] = None
self._ecommerce: typing.Optional[AsyncEcommerceClient] = None
- self._workspaces: typing.Optional[AsyncWorkspacesClient] = None
+ self._analyze: typing.Optional[AsyncAnalyzeClient] = None
@property
def token(self):
@@ -309,6 +342,14 @@ def token(self):
self._token = AsyncTokenClient(client_wrapper=self._client_wrapper)
return self._token
+ @property
+ def workspaces(self):
+ if self._workspaces is None:
+ from .resources.workspaces.client import AsyncWorkspacesClient # noqa: E402
+
+ self._workspaces = AsyncWorkspacesClient(client_wrapper=self._client_wrapper)
+ return self._workspaces
+
@property
def sites(self):
if self._sites is None:
@@ -317,6 +358,14 @@ def sites(self):
self._sites = AsyncSitesClient(client_wrapper=self._client_wrapper)
return self._sites
+ @property
+ def optimize(self):
+ if self._optimize is None:
+ from .resources.optimize.client import AsyncOptimizeClient # noqa: E402
+
+ self._optimize = AsyncOptimizeClient(client_wrapper=self._client_wrapper)
+ return self._optimize
+
@property
def collections(self):
if self._collections is None:
@@ -357,6 +406,14 @@ def assets(self):
self._assets = AsyncAssetsClient(client_wrapper=self._client_wrapper)
return self._assets
+ @property
+ def custom_fonts(self):
+ if self._custom_fonts is None:
+ from .resources.custom_fonts.client import AsyncCustomFontsClient # noqa: E402
+
+ self._custom_fonts = AsyncCustomFontsClient(client_wrapper=self._client_wrapper)
+ return self._custom_fonts
+
@property
def webhooks(self):
if self._webhooks is None:
@@ -406,9 +463,9 @@ def ecommerce(self):
return self._ecommerce
@property
- def workspaces(self):
- if self._workspaces is None:
- from .resources.workspaces.client import AsyncWorkspacesClient # noqa: E402
+ def analyze(self):
+ if self._analyze is None:
+ from .resources.analyze.client import AsyncAnalyzeClient # noqa: E402
- self._workspaces = AsyncWorkspacesClient(client_wrapper=self._client_wrapper)
- return self._workspaces
+ self._analyze = AsyncAnalyzeClient(client_wrapper=self._client_wrapper)
+ return self._analyze
diff --git a/src/webflow/core/client_wrapper.py b/src/webflow/core/client_wrapper.py
index 7f6db179..38398797 100644
--- a/src/webflow/core/client_wrapper.py
+++ b/src/webflow/core/client_wrapper.py
@@ -28,12 +28,12 @@ def get_headers(self) -> typing.Dict[str, str]:
import platform
headers: typing.Dict[str, str] = {
- "User-Agent": "webflow/2.0.0",
+ "User-Agent": "webflow/2.0.1",
"X-Fern-Language": "Python",
"X-Fern-Runtime": f"python/{platform.python_version()}",
"X-Fern-Platform": f"{platform.system().lower()}/{platform.release()}",
"X-Fern-SDK-Name": "webflow",
- "X-Fern-SDK-Version": "2.0.0",
+ "X-Fern-SDK-Version": "2.0.1",
**(self.get_custom_headers() or {}),
}
headers["Authorization"] = f"Bearer {self._get_access_token()}"
diff --git a/src/webflow/errors/__init__.py b/src/webflow/errors/__init__.py
index bd5f6185..14374f19 100644
--- a/src/webflow/errors/__init__.py
+++ b/src/webflow/errors/__init__.py
@@ -11,6 +11,7 @@
from .forbidden_error import ForbiddenError
from .internal_server_error import InternalServerError
from .not_found_error import NotFoundError
+ from .service_unavailable_error import ServiceUnavailableError
from .too_many_requests_error import TooManyRequestsError
from .unauthorized_error import UnauthorizedError
_dynamic_imports: typing.Dict[str, str] = {
@@ -19,6 +20,7 @@
"ForbiddenError": ".forbidden_error",
"InternalServerError": ".internal_server_error",
"NotFoundError": ".not_found_error",
+ "ServiceUnavailableError": ".service_unavailable_error",
"TooManyRequestsError": ".too_many_requests_error",
"UnauthorizedError": ".unauthorized_error",
}
@@ -51,6 +53,7 @@ def __dir__():
"ForbiddenError",
"InternalServerError",
"NotFoundError",
+ "ServiceUnavailableError",
"TooManyRequestsError",
"UnauthorizedError",
]
diff --git a/src/webflow/errors/service_unavailable_error.py b/src/webflow/errors/service_unavailable_error.py
new file mode 100644
index 00000000..50e2d017
--- /dev/null
+++ b/src/webflow/errors/service_unavailable_error.py
@@ -0,0 +1,11 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.api_error import ApiError
+from ..types.error import Error
+
+
+class ServiceUnavailableError(ApiError):
+ def __init__(self, body: Error, headers: typing.Optional[typing.Dict[str, str]] = None):
+ super().__init__(status_code=503, headers=headers, body=body)
diff --git a/src/webflow/resources/__init__.py b/src/webflow/resources/__init__.py
index 7eea2493..ab1794c2 100644
--- a/src/webflow/resources/__init__.py
+++ b/src/webflow/resources/__init__.py
@@ -7,12 +7,15 @@
if typing.TYPE_CHECKING:
from . import (
+ analyze,
assets,
collections,
components,
+ custom_fonts,
ecommerce,
forms,
inventory,
+ optimize,
orders,
pages,
products,
@@ -28,6 +31,15 @@
ComponentsUpdateContentResponse,
ComponentsUpdatePropertiesResponse,
)
+ from .custom_fonts import (
+ CustomFontBatchCreateRequestItemsItem,
+ CustomFontBatchCreateRequestItemsItemFontDisplay,
+ CustomFontBatchDeleteRequestItemsItem,
+ CustomFontsCreateRequestFontDisplay,
+ CustomFontsGetResponse,
+ CustomFontsUpdateRequestFontDisplay,
+ CustomFontsUpdateResponse,
+ )
from .inventory import EcommInventoryChangedPayload, InventoryUpdateRequestInventoryType
from .orders import OrdersListRequestStatus, OrdersRefundRequestReason
from .pages import (
@@ -37,12 +49,19 @@
UpdateStaticContentResponse,
)
from .products import ProductSkuCreateProduct, ProductSkuCreateSku, ProductsCreateSkuResponse
- from .sites import SitesPublishResponse
+ from .sites import SitesPublishResponse, SitesPublishResponsePublishScope
_dynamic_imports: typing.Dict[str, str] = {
"ComponentDomWriteNodesItem": ".components",
"ComponentPropertiesWritePropertiesItem": ".components",
"ComponentsUpdateContentResponse": ".components",
"ComponentsUpdatePropertiesResponse": ".components",
+ "CustomFontBatchCreateRequestItemsItem": ".custom_fonts",
+ "CustomFontBatchCreateRequestItemsItemFontDisplay": ".custom_fonts",
+ "CustomFontBatchDeleteRequestItemsItem": ".custom_fonts",
+ "CustomFontsCreateRequestFontDisplay": ".custom_fonts",
+ "CustomFontsGetResponse": ".custom_fonts",
+ "CustomFontsUpdateRequestFontDisplay": ".custom_fonts",
+ "CustomFontsUpdateResponse": ".custom_fonts",
"EcommInventoryChangedPayload": ".inventory",
"InventoryUpdateRequestInventoryType": ".inventory",
"OrdersListRequestStatus": ".orders",
@@ -54,13 +73,17 @@
"ProductSkuCreateSku": ".products",
"ProductsCreateSkuResponse": ".products",
"SitesPublishResponse": ".sites",
+ "SitesPublishResponsePublishScope": ".sites",
"UpdateStaticContentResponse": ".pages",
+ "analyze": ".analyze",
"assets": ".assets",
"collections": ".collections",
"components": ".components",
+ "custom_fonts": ".custom_fonts",
"ecommerce": ".ecommerce",
"forms": ".forms",
"inventory": ".inventory",
+ "optimize": ".optimize",
"orders": ".orders",
"pages": ".pages",
"products": ".products",
@@ -98,6 +121,13 @@ def __dir__():
"ComponentPropertiesWritePropertiesItem",
"ComponentsUpdateContentResponse",
"ComponentsUpdatePropertiesResponse",
+ "CustomFontBatchCreateRequestItemsItem",
+ "CustomFontBatchCreateRequestItemsItemFontDisplay",
+ "CustomFontBatchDeleteRequestItemsItem",
+ "CustomFontsCreateRequestFontDisplay",
+ "CustomFontsGetResponse",
+ "CustomFontsUpdateRequestFontDisplay",
+ "CustomFontsUpdateResponse",
"EcommInventoryChangedPayload",
"InventoryUpdateRequestInventoryType",
"OrdersListRequestStatus",
@@ -109,13 +139,17 @@ def __dir__():
"ProductSkuCreateSku",
"ProductsCreateSkuResponse",
"SitesPublishResponse",
+ "SitesPublishResponsePublishScope",
"UpdateStaticContentResponse",
+ "analyze",
"assets",
"collections",
"components",
+ "custom_fonts",
"ecommerce",
"forms",
"inventory",
+ "optimize",
"orders",
"pages",
"products",
diff --git a/src/webflow/resources/analyze/__init__.py b/src/webflow/resources/analyze/__init__.py
new file mode 100644
index 00000000..3b6577b9
--- /dev/null
+++ b/src/webflow/resources/analyze/__init__.py
@@ -0,0 +1,70 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+ from .resources import (
+ GoalsGoalPerformanceRequestDeviceType,
+ ReportsBrowserWindowHeightRequestDeviceType,
+ ReportsPageFlowRequestDeviceType,
+ ReportsScrollDepthRequestDeviceType,
+ ReportsTimeOnPageRequestDeviceType,
+ ReportsTopDimensionsRequestDeviceType,
+ ReportsTopEventsRequestDeviceType,
+ ReportsTopPagesRequestDeviceType,
+ ReportsTrafficRequestDeviceType,
+ goals,
+ reports,
+ )
+_dynamic_imports: typing.Dict[str, str] = {
+ "GoalsGoalPerformanceRequestDeviceType": ".resources",
+ "ReportsBrowserWindowHeightRequestDeviceType": ".resources",
+ "ReportsPageFlowRequestDeviceType": ".resources",
+ "ReportsScrollDepthRequestDeviceType": ".resources",
+ "ReportsTimeOnPageRequestDeviceType": ".resources",
+ "ReportsTopDimensionsRequestDeviceType": ".resources",
+ "ReportsTopEventsRequestDeviceType": ".resources",
+ "ReportsTopPagesRequestDeviceType": ".resources",
+ "ReportsTrafficRequestDeviceType": ".resources",
+ "goals": ".resources",
+ "reports": ".resources",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+ module_name = _dynamic_imports.get(attr_name)
+ if module_name is None:
+ raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+ try:
+ module = import_module(module_name, __package__)
+ if module_name == f".{attr_name}":
+ return module
+ else:
+ return getattr(module, attr_name)
+ except ImportError as e:
+ raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+ except AttributeError as e:
+ raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+ lazy_attrs = list(_dynamic_imports.keys())
+ return sorted(lazy_attrs)
+
+
+__all__ = [
+ "GoalsGoalPerformanceRequestDeviceType",
+ "ReportsBrowserWindowHeightRequestDeviceType",
+ "ReportsPageFlowRequestDeviceType",
+ "ReportsScrollDepthRequestDeviceType",
+ "ReportsTimeOnPageRequestDeviceType",
+ "ReportsTopDimensionsRequestDeviceType",
+ "ReportsTopEventsRequestDeviceType",
+ "ReportsTopPagesRequestDeviceType",
+ "ReportsTrafficRequestDeviceType",
+ "goals",
+ "reports",
+]
diff --git a/src/webflow/resources/analyze/client.py b/src/webflow/resources/analyze/client.py
new file mode 100644
index 00000000..98ac833c
--- /dev/null
+++ b/src/webflow/resources/analyze/client.py
@@ -0,0 +1,82 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .raw_client import AsyncRawAnalyzeClient, RawAnalyzeClient
+
+if typing.TYPE_CHECKING:
+ from .resources.goals.client import AsyncGoalsClient, GoalsClient
+ from .resources.reports.client import AsyncReportsClient, ReportsClient
+
+
+class AnalyzeClient:
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
+ self._raw_client = RawAnalyzeClient(client_wrapper=client_wrapper)
+ self._client_wrapper = client_wrapper
+ self._reports: typing.Optional[ReportsClient] = None
+ self._goals: typing.Optional[GoalsClient] = None
+
+ @property
+ def with_raw_response(self) -> RawAnalyzeClient:
+ """
+ Retrieves a raw implementation of this client that returns raw responses.
+
+ Returns
+ -------
+ RawAnalyzeClient
+ """
+ return self._raw_client
+
+ @property
+ def reports(self):
+ if self._reports is None:
+ from .resources.reports.client import ReportsClient # noqa: E402
+
+ self._reports = ReportsClient(client_wrapper=self._client_wrapper)
+ return self._reports
+
+ @property
+ def goals(self):
+ if self._goals is None:
+ from .resources.goals.client import GoalsClient # noqa: E402
+
+ self._goals = GoalsClient(client_wrapper=self._client_wrapper)
+ return self._goals
+
+
+class AsyncAnalyzeClient:
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
+ self._raw_client = AsyncRawAnalyzeClient(client_wrapper=client_wrapper)
+ self._client_wrapper = client_wrapper
+ self._reports: typing.Optional[AsyncReportsClient] = None
+ self._goals: typing.Optional[AsyncGoalsClient] = None
+
+ @property
+ def with_raw_response(self) -> AsyncRawAnalyzeClient:
+ """
+ Retrieves a raw implementation of this client that returns raw responses.
+
+ Returns
+ -------
+ AsyncRawAnalyzeClient
+ """
+ return self._raw_client
+
+ @property
+ def reports(self):
+ if self._reports is None:
+ from .resources.reports.client import AsyncReportsClient # noqa: E402
+
+ self._reports = AsyncReportsClient(client_wrapper=self._client_wrapper)
+ return self._reports
+
+ @property
+ def goals(self):
+ if self._goals is None:
+ from .resources.goals.client import AsyncGoalsClient # noqa: E402
+
+ self._goals = AsyncGoalsClient(client_wrapper=self._client_wrapper)
+ return self._goals
diff --git a/src/webflow/resources/analyze/raw_client.py b/src/webflow/resources/analyze/raw_client.py
new file mode 100644
index 00000000..a4bd1051
--- /dev/null
+++ b/src/webflow/resources/analyze/raw_client.py
@@ -0,0 +1,13 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+
+
+class RawAnalyzeClient:
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
+ self._client_wrapper = client_wrapper
+
+
+class AsyncRawAnalyzeClient:
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
+ self._client_wrapper = client_wrapper
diff --git a/src/webflow/resources/analyze/resources/__init__.py b/src/webflow/resources/analyze/resources/__init__.py
new file mode 100644
index 00000000..bce587ff
--- /dev/null
+++ b/src/webflow/resources/analyze/resources/__init__.py
@@ -0,0 +1,69 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+ from . import goals, reports
+ from .goals import GoalsGoalPerformanceRequestDeviceType
+ from .reports import (
+ ReportsBrowserWindowHeightRequestDeviceType,
+ ReportsPageFlowRequestDeviceType,
+ ReportsScrollDepthRequestDeviceType,
+ ReportsTimeOnPageRequestDeviceType,
+ ReportsTopDimensionsRequestDeviceType,
+ ReportsTopEventsRequestDeviceType,
+ ReportsTopPagesRequestDeviceType,
+ ReportsTrafficRequestDeviceType,
+ )
+_dynamic_imports: typing.Dict[str, str] = {
+ "GoalsGoalPerformanceRequestDeviceType": ".goals",
+ "ReportsBrowserWindowHeightRequestDeviceType": ".reports",
+ "ReportsPageFlowRequestDeviceType": ".reports",
+ "ReportsScrollDepthRequestDeviceType": ".reports",
+ "ReportsTimeOnPageRequestDeviceType": ".reports",
+ "ReportsTopDimensionsRequestDeviceType": ".reports",
+ "ReportsTopEventsRequestDeviceType": ".reports",
+ "ReportsTopPagesRequestDeviceType": ".reports",
+ "ReportsTrafficRequestDeviceType": ".reports",
+ "goals": ".goals",
+ "reports": ".reports",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+ module_name = _dynamic_imports.get(attr_name)
+ if module_name is None:
+ raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+ try:
+ module = import_module(module_name, __package__)
+ if module_name == f".{attr_name}":
+ return module
+ else:
+ return getattr(module, attr_name)
+ except ImportError as e:
+ raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+ except AttributeError as e:
+ raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+ lazy_attrs = list(_dynamic_imports.keys())
+ return sorted(lazy_attrs)
+
+
+__all__ = [
+ "GoalsGoalPerformanceRequestDeviceType",
+ "ReportsBrowserWindowHeightRequestDeviceType",
+ "ReportsPageFlowRequestDeviceType",
+ "ReportsScrollDepthRequestDeviceType",
+ "ReportsTimeOnPageRequestDeviceType",
+ "ReportsTopDimensionsRequestDeviceType",
+ "ReportsTopEventsRequestDeviceType",
+ "ReportsTopPagesRequestDeviceType",
+ "ReportsTrafficRequestDeviceType",
+ "goals",
+ "reports",
+]
diff --git a/src/webflow/resources/analyze/resources/goals/__init__.py b/src/webflow/resources/analyze/resources/goals/__init__.py
new file mode 100644
index 00000000..90457894
--- /dev/null
+++ b/src/webflow/resources/analyze/resources/goals/__init__.py
@@ -0,0 +1,34 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+ from .types import GoalsGoalPerformanceRequestDeviceType
+_dynamic_imports: typing.Dict[str, str] = {"GoalsGoalPerformanceRequestDeviceType": ".types"}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+ module_name = _dynamic_imports.get(attr_name)
+ if module_name is None:
+ raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+ try:
+ module = import_module(module_name, __package__)
+ if module_name == f".{attr_name}":
+ return module
+ else:
+ return getattr(module, attr_name)
+ except ImportError as e:
+ raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+ except AttributeError as e:
+ raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+ lazy_attrs = list(_dynamic_imports.keys())
+ return sorted(lazy_attrs)
+
+
+__all__ = ["GoalsGoalPerformanceRequestDeviceType"]
diff --git a/src/webflow/resources/analyze/resources/goals/client.py b/src/webflow/resources/analyze/resources/goals/client.py
new file mode 100644
index 00000000..4b0c69ed
--- /dev/null
+++ b/src/webflow/resources/analyze/resources/goals/client.py
@@ -0,0 +1,414 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .....core.request_options import RequestOptions
+from .....types.analyze_bucket_time_zone import AnalyzeBucketTimeZone
+from .....types.goal_performance_filter import GoalPerformanceFilter
+from .....types.goal_performance_response import GoalPerformanceResponse
+from .....types.goals_response import GoalsResponse
+from .raw_client import AsyncRawGoalsClient, RawGoalsClient
+from .types.goals_goal_performance_request_device_type import GoalsGoalPerformanceRequestDeviceType
+
+
+class GoalsClient:
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
+ self._raw_client = RawGoalsClient(client_wrapper=client_wrapper)
+
+ @property
+ def with_raw_response(self) -> RawGoalsClient:
+ """
+ Retrieves a raw implementation of this client that returns raw responses.
+
+ Returns
+ -------
+ RawGoalsClient
+ """
+ return self._raw_client
+
+ def list_goals(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GoalsResponse:
+ """
+ Returns the goals configured for a site. This endpoint returns a list of goals, not a report. It takes no time window, filters, or other query parameters, and unknown query parameters return `400 analyze_input_validation`.
+
+ Each goal includes its type (`goalType`) and whether it's a site goal (`isSiteGoal`). Integration goals also include `integrationSource`, and HubSpot or Marketo form goals include the `formId`. Use a goal's `goalId` with [Get Goal Performance](/data/reference/analyze/goal-performance) to get its daily conversions.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ GoalsResponse
+ The site's configured goals.
+
+ Examples
+ --------
+ from webflow import Webflow
+
+ client = Webflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+ client.analyze.goals.list_goals(
+ site_id="580e63e98c9a982ac9b8b741",
+ )
+ """
+ _response = self._raw_client.list_goals(site_id, request_options=request_options)
+ return _response.data
+
+ def goal_performance(
+ self,
+ site_id: str,
+ goal_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ bucket_time_zone: typing.Optional[AnalyzeBucketTimeZone] = None,
+ device_type: typing.Optional[GoalsGoalPerformanceRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[GoalPerformanceFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> GoalPerformanceResponse:
+ """
+ Returns daily conversion counts for one goal over a time window, together with the goal's configuration (the same object [List Goals](/data/reference/analyze/list-goals) returns). Conversions are always counted as unique conversions.
+
+ Days are bucketed in `bucketTimeZone`, which defaults to `UTC`. An unknown `goal_id` returns `404`. A goal with no conversions in the window returns an empty `data` array. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ goal_id : str
+ Identifier of the goal, from `goalId` in [List Goals](/data/reference/analyze/list-goals). A numeric string, not a Webflow object ID.
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ bucket_time_zone : typing.Optional[AnalyzeBucketTimeZone]
+ IANA time zone used to align daily bucket boundaries. Defaults to `UTC`.
+
+ device_type : typing.Optional[GoalsGoalPerformanceRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[GoalPerformanceFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `GoalPerformanceFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ GoalPerformanceResponse
+ The goal's configuration and daily conversion counts for the requested window and filters.
+
+ Examples
+ --------
+ import datetime
+
+ from webflow import Webflow
+
+ client = Webflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+ client.analyze.goals.goal_performance(
+ site_id="580e63e98c9a982ac9b8b741",
+ goal_id="198020177",
+ start_time=datetime.datetime.fromisoformat(
+ "2026-04-01 00:00:00+00:00",
+ ),
+ end_time=datetime.datetime.fromisoformat(
+ "2026-04-08 00:00:00+00:00",
+ ),
+ bucket_time_zone="America/New_York",
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+ )
+ """
+ _response = self._raw_client.goal_performance(
+ site_id,
+ goal_id,
+ start_time=start_time,
+ end_time=end_time,
+ bucket_time_zone=bucket_time_zone,
+ device_type=device_type,
+ country=country,
+ page_path=page_path,
+ traffic_source=traffic_source,
+ referrer=referrer,
+ browser=browser,
+ utm_campaign=utm_campaign,
+ utm_medium=utm_medium,
+ utm_source=utm_source,
+ filter=filter,
+ request_options=request_options,
+ )
+ return _response.data
+
+
+class AsyncGoalsClient:
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
+ self._raw_client = AsyncRawGoalsClient(client_wrapper=client_wrapper)
+
+ @property
+ def with_raw_response(self) -> AsyncRawGoalsClient:
+ """
+ Retrieves a raw implementation of this client that returns raw responses.
+
+ Returns
+ -------
+ AsyncRawGoalsClient
+ """
+ return self._raw_client
+
+ async def list_goals(
+ self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> GoalsResponse:
+ """
+ Returns the goals configured for a site. This endpoint returns a list of goals, not a report. It takes no time window, filters, or other query parameters, and unknown query parameters return `400 analyze_input_validation`.
+
+ Each goal includes its type (`goalType`) and whether it's a site goal (`isSiteGoal`). Integration goals also include `integrationSource`, and HubSpot or Marketo form goals include the `formId`. Use a goal's `goalId` with [Get Goal Performance](/data/reference/analyze/goal-performance) to get its daily conversions.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ GoalsResponse
+ The site's configured goals.
+
+ Examples
+ --------
+ import asyncio
+
+ from webflow import AsyncWebflow
+
+ client = AsyncWebflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+
+
+ async def main() -> None:
+ await client.analyze.goals.list_goals(
+ site_id="580e63e98c9a982ac9b8b741",
+ )
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.list_goals(site_id, request_options=request_options)
+ return _response.data
+
+ async def goal_performance(
+ self,
+ site_id: str,
+ goal_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ bucket_time_zone: typing.Optional[AnalyzeBucketTimeZone] = None,
+ device_type: typing.Optional[GoalsGoalPerformanceRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[GoalPerformanceFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> GoalPerformanceResponse:
+ """
+ Returns daily conversion counts for one goal over a time window, together with the goal's configuration (the same object [List Goals](/data/reference/analyze/list-goals) returns). Conversions are always counted as unique conversions.
+
+ Days are bucketed in `bucketTimeZone`, which defaults to `UTC`. An unknown `goal_id` returns `404`. A goal with no conversions in the window returns an empty `data` array. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ goal_id : str
+ Identifier of the goal, from `goalId` in [List Goals](/data/reference/analyze/list-goals). A numeric string, not a Webflow object ID.
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ bucket_time_zone : typing.Optional[AnalyzeBucketTimeZone]
+ IANA time zone used to align daily bucket boundaries. Defaults to `UTC`.
+
+ device_type : typing.Optional[GoalsGoalPerformanceRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[GoalPerformanceFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `GoalPerformanceFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ GoalPerformanceResponse
+ The goal's configuration and daily conversion counts for the requested window and filters.
+
+ Examples
+ --------
+ import asyncio
+ import datetime
+
+ from webflow import AsyncWebflow
+
+ client = AsyncWebflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+
+
+ async def main() -> None:
+ await client.analyze.goals.goal_performance(
+ site_id="580e63e98c9a982ac9b8b741",
+ goal_id="198020177",
+ start_time=datetime.datetime.fromisoformat(
+ "2026-04-01 00:00:00+00:00",
+ ),
+ end_time=datetime.datetime.fromisoformat(
+ "2026-04-08 00:00:00+00:00",
+ ),
+ bucket_time_zone="America/New_York",
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+ )
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.goal_performance(
+ site_id,
+ goal_id,
+ start_time=start_time,
+ end_time=end_time,
+ bucket_time_zone=bucket_time_zone,
+ device_type=device_type,
+ country=country,
+ page_path=page_path,
+ traffic_source=traffic_source,
+ referrer=referrer,
+ browser=browser,
+ utm_campaign=utm_campaign,
+ utm_medium=utm_medium,
+ utm_source=utm_source,
+ filter=filter,
+ request_options=request_options,
+ )
+ return _response.data
diff --git a/src/webflow/resources/analyze/resources/goals/raw_client.py b/src/webflow/resources/analyze/resources/goals/raw_client.py
new file mode 100644
index 00000000..0faf9f98
--- /dev/null
+++ b/src/webflow/resources/analyze/resources/goals/raw_client.py
@@ -0,0 +1,664 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+from json.decoder import JSONDecodeError
+
+from .....core.api_error import ApiError
+from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .....core.datetime_utils import serialize_datetime
+from .....core.http_response import AsyncHttpResponse, HttpResponse
+from .....core.jsonable_encoder import jsonable_encoder
+from .....core.parse_error import ParsingError
+from .....core.pydantic_utilities import parse_obj_as
+from .....core.request_options import RequestOptions
+from .....core.serialization import convert_and_respect_annotation_metadata
+from .....errors.bad_request_error import BadRequestError
+from .....errors.forbidden_error import ForbiddenError
+from .....errors.internal_server_error import InternalServerError
+from .....errors.not_found_error import NotFoundError
+from .....errors.too_many_requests_error import TooManyRequestsError
+from .....errors.unauthorized_error import UnauthorizedError
+from .....types.analyze_bucket_time_zone import AnalyzeBucketTimeZone
+from .....types.error import Error
+from .....types.goal_performance_filter import GoalPerformanceFilter
+from .....types.goal_performance_response import GoalPerformanceResponse
+from .....types.goals_response import GoalsResponse
+from .types.goals_goal_performance_request_device_type import GoalsGoalPerformanceRequestDeviceType
+from pydantic import ValidationError
+
+
+class RawGoalsClient:
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
+ self._client_wrapper = client_wrapper
+
+ def list_goals(
+ self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> HttpResponse[GoalsResponse]:
+ """
+ Returns the goals configured for a site. This endpoint returns a list of goals, not a report. It takes no time window, filters, or other query parameters, and unknown query parameters return `400 analyze_input_validation`.
+
+ Each goal includes its type (`goalType`) and whether it's a site goal (`isSiteGoal`). Integration goals also include `integrationSource`, and HubSpot or Marketo form goals include the `formId`. Use a goal's `goalId` with [Get Goal Performance](/data/reference/analyze/goal-performance) to get its daily conversions.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[GoalsResponse]
+ The site's configured goals.
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ f"sites/{jsonable_encoder(site_id)}/analyze/goals",
+ base_url=self._client_wrapper.get_environment().base,
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ GoalsResponse,
+ parse_obj_as(
+ type_=GoalsResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ def goal_performance(
+ self,
+ site_id: str,
+ goal_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ bucket_time_zone: typing.Optional[AnalyzeBucketTimeZone] = None,
+ device_type: typing.Optional[GoalsGoalPerformanceRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[GoalPerformanceFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> HttpResponse[GoalPerformanceResponse]:
+ """
+ Returns daily conversion counts for one goal over a time window, together with the goal's configuration (the same object [List Goals](/data/reference/analyze/list-goals) returns). Conversions are always counted as unique conversions.
+
+ Days are bucketed in `bucketTimeZone`, which defaults to `UTC`. An unknown `goal_id` returns `404`. A goal with no conversions in the window returns an empty `data` array. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ goal_id : str
+ Identifier of the goal, from `goalId` in [List Goals](/data/reference/analyze/list-goals). A numeric string, not a Webflow object ID.
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ bucket_time_zone : typing.Optional[AnalyzeBucketTimeZone]
+ IANA time zone used to align daily bucket boundaries. Defaults to `UTC`.
+
+ device_type : typing.Optional[GoalsGoalPerformanceRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[GoalPerformanceFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `GoalPerformanceFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[GoalPerformanceResponse]
+ The goal's configuration and daily conversion counts for the requested window and filters.
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ f"sites/{jsonable_encoder(site_id)}/analyze/goals/{jsonable_encoder(goal_id)}/performance",
+ base_url=self._client_wrapper.get_environment().base,
+ method="GET",
+ params={
+ "startTime": serialize_datetime(start_time),
+ "endTime": serialize_datetime(end_time),
+ "bucketTimeZone": bucket_time_zone,
+ "deviceType": device_type,
+ "country": country,
+ "pagePath": page_path,
+ "trafficSource": traffic_source,
+ "referrer": referrer,
+ "browser": browser,
+ "utmCampaign": utm_campaign,
+ "utmMedium": utm_medium,
+ "utmSource": utm_source,
+ "filter": convert_and_respect_annotation_metadata(
+ object_=filter, annotation=GoalPerformanceFilter, direction="write"
+ ),
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ GoalPerformanceResponse,
+ parse_obj_as(
+ type_=GoalPerformanceResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawGoalsClient:
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
+ self._client_wrapper = client_wrapper
+
+ async def list_goals(
+ self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None
+ ) -> AsyncHttpResponse[GoalsResponse]:
+ """
+ Returns the goals configured for a site. This endpoint returns a list of goals, not a report. It takes no time window, filters, or other query parameters, and unknown query parameters return `400 analyze_input_validation`.
+
+ Each goal includes its type (`goalType`) and whether it's a site goal (`isSiteGoal`). Integration goals also include `integrationSource`, and HubSpot or Marketo form goals include the `formId`. Use a goal's `goalId` with [Get Goal Performance](/data/reference/analyze/goal-performance) to get its daily conversions.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[GoalsResponse]
+ The site's configured goals.
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ f"sites/{jsonable_encoder(site_id)}/analyze/goals",
+ base_url=self._client_wrapper.get_environment().base,
+ method="GET",
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ GoalsResponse,
+ parse_obj_as(
+ type_=GoalsResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ async def goal_performance(
+ self,
+ site_id: str,
+ goal_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ bucket_time_zone: typing.Optional[AnalyzeBucketTimeZone] = None,
+ device_type: typing.Optional[GoalsGoalPerformanceRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[GoalPerformanceFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> AsyncHttpResponse[GoalPerformanceResponse]:
+ """
+ Returns daily conversion counts for one goal over a time window, together with the goal's configuration (the same object [List Goals](/data/reference/analyze/list-goals) returns). Conversions are always counted as unique conversions.
+
+ Days are bucketed in `bucketTimeZone`, which defaults to `UTC`. An unknown `goal_id` returns `404`. A goal with no conversions in the window returns an empty `data` array. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ goal_id : str
+ Identifier of the goal, from `goalId` in [List Goals](/data/reference/analyze/list-goals). A numeric string, not a Webflow object ID.
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ bucket_time_zone : typing.Optional[AnalyzeBucketTimeZone]
+ IANA time zone used to align daily bucket boundaries. Defaults to `UTC`.
+
+ device_type : typing.Optional[GoalsGoalPerformanceRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[GoalPerformanceFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `GoalPerformanceFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[GoalPerformanceResponse]
+ The goal's configuration and daily conversion counts for the requested window and filters.
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ f"sites/{jsonable_encoder(site_id)}/analyze/goals/{jsonable_encoder(goal_id)}/performance",
+ base_url=self._client_wrapper.get_environment().base,
+ method="GET",
+ params={
+ "startTime": serialize_datetime(start_time),
+ "endTime": serialize_datetime(end_time),
+ "bucketTimeZone": bucket_time_zone,
+ "deviceType": device_type,
+ "country": country,
+ "pagePath": page_path,
+ "trafficSource": traffic_source,
+ "referrer": referrer,
+ "browser": browser,
+ "utmCampaign": utm_campaign,
+ "utmMedium": utm_medium,
+ "utmSource": utm_source,
+ "filter": convert_and_respect_annotation_metadata(
+ object_=filter, annotation=GoalPerformanceFilter, direction="write"
+ ),
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ GoalPerformanceResponse,
+ parse_obj_as(
+ type_=GoalPerformanceResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
diff --git a/src/webflow/resources/analyze/resources/goals/types/__init__.py b/src/webflow/resources/analyze/resources/goals/types/__init__.py
new file mode 100644
index 00000000..409d018d
--- /dev/null
+++ b/src/webflow/resources/analyze/resources/goals/types/__init__.py
@@ -0,0 +1,36 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+ from .goals_goal_performance_request_device_type import GoalsGoalPerformanceRequestDeviceType
+_dynamic_imports: typing.Dict[str, str] = {
+ "GoalsGoalPerformanceRequestDeviceType": ".goals_goal_performance_request_device_type"
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+ module_name = _dynamic_imports.get(attr_name)
+ if module_name is None:
+ raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+ try:
+ module = import_module(module_name, __package__)
+ if module_name == f".{attr_name}":
+ return module
+ else:
+ return getattr(module, attr_name)
+ except ImportError as e:
+ raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+ except AttributeError as e:
+ raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+ lazy_attrs = list(_dynamic_imports.keys())
+ return sorted(lazy_attrs)
+
+
+__all__ = ["GoalsGoalPerformanceRequestDeviceType"]
diff --git a/src/webflow/resources/analyze/resources/goals/types/goals_goal_performance_request_device_type.py b/src/webflow/resources/analyze/resources/goals/types/goals_goal_performance_request_device_type.py
new file mode 100644
index 00000000..9348be7b
--- /dev/null
+++ b/src/webflow/resources/analyze/resources/goals/types/goals_goal_performance_request_device_type.py
@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+GoalsGoalPerformanceRequestDeviceType = typing.Union[typing.Literal["desktop", "mobile", "tablet"], typing.Any]
diff --git a/src/webflow/resources/analyze/resources/reports/__init__.py b/src/webflow/resources/analyze/resources/reports/__init__.py
new file mode 100644
index 00000000..f6c66040
--- /dev/null
+++ b/src/webflow/resources/analyze/resources/reports/__init__.py
@@ -0,0 +1,61 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+ from .types import (
+ ReportsBrowserWindowHeightRequestDeviceType,
+ ReportsPageFlowRequestDeviceType,
+ ReportsScrollDepthRequestDeviceType,
+ ReportsTimeOnPageRequestDeviceType,
+ ReportsTopDimensionsRequestDeviceType,
+ ReportsTopEventsRequestDeviceType,
+ ReportsTopPagesRequestDeviceType,
+ ReportsTrafficRequestDeviceType,
+ )
+_dynamic_imports: typing.Dict[str, str] = {
+ "ReportsBrowserWindowHeightRequestDeviceType": ".types",
+ "ReportsPageFlowRequestDeviceType": ".types",
+ "ReportsScrollDepthRequestDeviceType": ".types",
+ "ReportsTimeOnPageRequestDeviceType": ".types",
+ "ReportsTopDimensionsRequestDeviceType": ".types",
+ "ReportsTopEventsRequestDeviceType": ".types",
+ "ReportsTopPagesRequestDeviceType": ".types",
+ "ReportsTrafficRequestDeviceType": ".types",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+ module_name = _dynamic_imports.get(attr_name)
+ if module_name is None:
+ raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+ try:
+ module = import_module(module_name, __package__)
+ if module_name == f".{attr_name}":
+ return module
+ else:
+ return getattr(module, attr_name)
+ except ImportError as e:
+ raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+ except AttributeError as e:
+ raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+ lazy_attrs = list(_dynamic_imports.keys())
+ return sorted(lazy_attrs)
+
+
+__all__ = [
+ "ReportsBrowserWindowHeightRequestDeviceType",
+ "ReportsPageFlowRequestDeviceType",
+ "ReportsScrollDepthRequestDeviceType",
+ "ReportsTimeOnPageRequestDeviceType",
+ "ReportsTopDimensionsRequestDeviceType",
+ "ReportsTopEventsRequestDeviceType",
+ "ReportsTopPagesRequestDeviceType",
+ "ReportsTrafficRequestDeviceType",
+]
diff --git a/src/webflow/resources/analyze/resources/reports/client.py b/src/webflow/resources/analyze/resources/reports/client.py
new file mode 100644
index 00000000..70b61d4c
--- /dev/null
+++ b/src/webflow/resources/analyze/resources/reports/client.py
@@ -0,0 +1,2336 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .....core.request_options import RequestOptions
+from .....types.analyze_bucket_time_zone import AnalyzeBucketTimeZone
+from .....types.analyze_daily_timeseries_query import AnalyzeDailyTimeseriesQuery
+from .....types.browser_window_height_filter import BrowserWindowHeightFilter
+from .....types.browser_window_height_response import BrowserWindowHeightResponse
+from .....types.page_flow_direction import PageFlowDirection
+from .....types.page_flow_filter import PageFlowFilter
+from .....types.page_flow_metric_scope import PageFlowMetricScope
+from .....types.page_flow_response import PageFlowResponse
+from .....types.scroll_depth_filter import ScrollDepthFilter
+from .....types.scroll_depth_response import ScrollDepthResponse
+from .....types.time_on_page_filter import TimeOnPageFilter
+from .....types.time_on_page_metric_scope import TimeOnPageMetricScope
+from .....types.time_on_page_response import TimeOnPageResponse
+from .....types.time_on_page_timeseries_query import TimeOnPageTimeseriesQuery
+from .....types.top_dimensions_dimension import TopDimensionsDimension
+from .....types.top_dimensions_filter import TopDimensionsFilter
+from .....types.top_dimensions_metric_scope import TopDimensionsMetricScope
+from .....types.top_dimensions_response import TopDimensionsResponse
+from .....types.top_events_filter import TopEventsFilter
+from .....types.top_events_response import TopEventsResponse
+from .....types.top_pages_filter import TopPagesFilter
+from .....types.top_pages_response import TopPagesResponse
+from .....types.top_pages_sort_by import TopPagesSortBy
+from .....types.traffic_filter import TrafficFilter
+from .....types.traffic_metric_scope import TrafficMetricScope
+from .....types.traffic_response import TrafficResponse
+from .raw_client import AsyncRawReportsClient, RawReportsClient
+from .types.reports_browser_window_height_request_device_type import ReportsBrowserWindowHeightRequestDeviceType
+from .types.reports_page_flow_request_device_type import ReportsPageFlowRequestDeviceType
+from .types.reports_scroll_depth_request_device_type import ReportsScrollDepthRequestDeviceType
+from .types.reports_time_on_page_request_device_type import ReportsTimeOnPageRequestDeviceType
+from .types.reports_top_dimensions_request_device_type import ReportsTopDimensionsRequestDeviceType
+from .types.reports_top_events_request_device_type import ReportsTopEventsRequestDeviceType
+from .types.reports_top_pages_request_device_type import ReportsTopPagesRequestDeviceType
+from .types.reports_traffic_request_device_type import ReportsTrafficRequestDeviceType
+
+
+class ReportsClient:
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
+ self._raw_client = RawReportsClient(client_wrapper=client_wrapper)
+
+ @property
+ def with_raw_response(self) -> RawReportsClient:
+ """
+ Retrieves a raw implementation of this client that returns raw responses.
+
+ Returns
+ -------
+ RawReportsClient
+ """
+ return self._raw_client
+
+ def traffic(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ metric_scope: TrafficMetricScope,
+ bucket_time_zone: AnalyzeBucketTimeZone,
+ device_type: typing.Optional[ReportsTrafficRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[TrafficFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> TrafficResponse:
+ """
+ Returns a daily time series of a single metric — sessions, users, or page views — over a time window.
+
+ Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ metric_scope : TrafficMetricScope
+ The unit each `count` data point is measured in.
+
+ bucket_time_zone : AnalyzeBucketTimeZone
+ IANA time zone used to align daily bucket boundaries.
+
+ device_type : typing.Optional[ReportsTrafficRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[TrafficFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TrafficFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ TrafficResponse
+ Time-series traffic report for the requested window and filters.
+
+ Examples
+ --------
+ import datetime
+
+ from webflow import Webflow
+
+ client = Webflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+ client.analyze.reports.traffic(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat(
+ "2026-04-01 00:00:00+00:00",
+ ),
+ end_time=datetime.datetime.fromisoformat(
+ "2026-04-08 00:00:00+00:00",
+ ),
+ metric_scope="session",
+ bucket_time_zone="America/New_York",
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+ )
+ """
+ _response = self._raw_client.traffic(
+ site_id,
+ start_time=start_time,
+ end_time=end_time,
+ metric_scope=metric_scope,
+ bucket_time_zone=bucket_time_zone,
+ device_type=device_type,
+ country=country,
+ page_path=page_path,
+ traffic_source=traffic_source,
+ referrer=referrer,
+ browser=browser,
+ utm_campaign=utm_campaign,
+ utm_medium=utm_medium,
+ utm_source=utm_source,
+ filter=filter,
+ request_options=request_options,
+ )
+ return _response.data
+
+ def top_pages(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ sort_by: typing.Optional[TopPagesSortBy] = None,
+ limit: typing.Optional[int] = None,
+ timeseries: typing.Optional[AnalyzeDailyTimeseriesQuery] = None,
+ device_type: typing.Optional[ReportsTopPagesRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[TopPagesFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> TopPagesResponse:
+ """
+ Returns the most-visited pages over a time window, ranked by `sortBy` (sessions, users, or page views).
+
+ Each row carries all three scope counts; `sortBy` only governs ordering. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ Set `timeseries[bucketTimeZone]` to attach a daily page view `timeseries` to each row. Bucket counts are always page views regardless of `sortBy`. Row-level counts honor the requested sort, but the timeseries does not.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ sort_by : typing.Optional[TopPagesSortBy]
+ Metric used to rank rows in the response, descending. Defaults to `session`.
+
+ limit : typing.Optional[int]
+ Maximum number of rows to return. Defaults to `25`, up to a maximum of `250`.
+
+ timeseries : typing.Optional[AnalyzeDailyTimeseriesQuery]
+ Include a daily page view `timeseries` for each row, bucketed in the supplied IANA time zone. Omit this parameter to return ranked rows without per-page timeseries data.
+
+ device_type : typing.Optional[ReportsTopPagesRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[TopPagesFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TopPagesFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ TopPagesResponse
+ Pages ranked by `sortBy` for the requested window and filters.
+
+ Examples
+ --------
+ import datetime
+
+ from webflow import Webflow
+
+ client = Webflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+ client.analyze.reports.top_pages(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat(
+ "2026-04-01 00:00:00+00:00",
+ ),
+ end_time=datetime.datetime.fromisoformat(
+ "2026-04-08 00:00:00+00:00",
+ ),
+ sort_by="session",
+ limit=1,
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+ )
+ """
+ _response = self._raw_client.top_pages(
+ site_id,
+ start_time=start_time,
+ end_time=end_time,
+ sort_by=sort_by,
+ limit=limit,
+ timeseries=timeseries,
+ device_type=device_type,
+ country=country,
+ page_path=page_path,
+ traffic_source=traffic_source,
+ referrer=referrer,
+ browser=browser,
+ utm_campaign=utm_campaign,
+ utm_medium=utm_medium,
+ utm_source=utm_source,
+ filter=filter,
+ request_options=request_options,
+ )
+ return _response.data
+
+ def top_dimensions(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ dimension: TopDimensionsDimension,
+ metric_scope: TopDimensionsMetricScope,
+ limit: typing.Optional[int] = None,
+ device_type: typing.Optional[ReportsTopDimensionsRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[TopDimensionsFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> TopDimensionsResponse:
+ """
+ Returns the top values within a chosen `dimension` — top countries, top traffic sources, top campaigns, top audiences, and so on — over a time window, ranked by sessions or users.
+
+ Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ dimension : TopDimensionsDimension
+ The dimension whose top values are ranked. See `TopDimensionsDimension` for the supported values.
+
+ metric_scope : TopDimensionsMetricScope
+ The unit each row's `count` is measured in — sessions or users.
+
+ limit : typing.Optional[int]
+ Maximum number of rows to return. Defaults to `25`, up to a maximum of `100`.
+
+ device_type : typing.Optional[ReportsTopDimensionsRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[TopDimensionsFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TopDimensionsFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ TopDimensionsResponse
+ Dimension values ranked by `count` for the requested window and filters.
+
+ Examples
+ --------
+ import datetime
+
+ from webflow import Webflow
+
+ client = Webflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+ client.analyze.reports.top_dimensions(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat(
+ "2026-04-01 00:00:00+00:00",
+ ),
+ end_time=datetime.datetime.fromisoformat(
+ "2026-04-08 00:00:00+00:00",
+ ),
+ dimension="country",
+ metric_scope="session",
+ limit=1,
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+ )
+ """
+ _response = self._raw_client.top_dimensions(
+ site_id,
+ start_time=start_time,
+ end_time=end_time,
+ dimension=dimension,
+ metric_scope=metric_scope,
+ limit=limit,
+ device_type=device_type,
+ country=country,
+ page_path=page_path,
+ traffic_source=traffic_source,
+ referrer=referrer,
+ browser=browser,
+ utm_campaign=utm_campaign,
+ utm_medium=utm_medium,
+ utm_source=utm_source,
+ filter=filter,
+ request_options=request_options,
+ )
+ return _response.data
+
+ def top_events(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ limit: typing.Optional[int] = None,
+ timeseries: typing.Optional[AnalyzeDailyTimeseriesQuery] = None,
+ device_type: typing.Optional[ReportsTopEventsRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[TopEventsFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> TopEventsResponse:
+ """
+ Returns the top events over a time window, ranked by how often they occurred.
+
+ Events are counted individually, not rolled up into sessions, users, or page views — so this report has no `metricScope`. Each row's `count` is how many times the event occurred. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ Set `timeseries[bucketTimeZone]` to attach a daily event count `timeseries` to each row.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ limit : typing.Optional[int]
+ Maximum number of rows to return. Defaults to `25`, up to a maximum of `250`.
+
+ timeseries : typing.Optional[AnalyzeDailyTimeseriesQuery]
+ Include a daily event count `timeseries` for each row, bucketed in the supplied IANA time zone. Omit this parameter to return ranked rows without per-event timeseries data.
+
+ device_type : typing.Optional[ReportsTopEventsRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[TopEventsFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TopEventsFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ TopEventsResponse
+ Events ranked by how frequently they occurred, for the requested window and filters.
+
+ Examples
+ --------
+ import datetime
+
+ from webflow import Webflow
+
+ client = Webflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+ client.analyze.reports.top_events(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat(
+ "2026-04-01 00:00:00+00:00",
+ ),
+ end_time=datetime.datetime.fromisoformat(
+ "2026-04-08 00:00:00+00:00",
+ ),
+ limit=1,
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+ )
+ """
+ _response = self._raw_client.top_events(
+ site_id,
+ start_time=start_time,
+ end_time=end_time,
+ limit=limit,
+ timeseries=timeseries,
+ device_type=device_type,
+ country=country,
+ page_path=page_path,
+ traffic_source=traffic_source,
+ browser=browser,
+ utm_campaign=utm_campaign,
+ utm_medium=utm_medium,
+ utm_source=utm_source,
+ filter=filter,
+ request_options=request_options,
+ )
+ return _response.data
+
+ def time_on_page(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ metric_scope: TimeOnPageMetricScope,
+ timeseries: typing.Optional[TimeOnPageTimeseriesQuery] = None,
+ device_type: typing.Optional[ReportsTimeOnPageRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[TimeOnPageFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> TimeOnPageResponse:
+ """
+ Returns the average time on page over a time window — as a single aggregate value, or bucketed by day or week when `timeseries` is supplied.
+
+ Choose how the average is computed with `metricScope` (per session, user, or page view). Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ metric_scope : TimeOnPageMetricScope
+ How the average time on page is computed — per session, user, or page view.
+
+ timeseries : typing.Optional[TimeOnPageTimeseriesQuery]
+ Include bucketed average time data using the supplied granularity and IANA time zone. Omit this parameter to return a single aggregate value for the requested window.
+
+ device_type : typing.Optional[ReportsTimeOnPageRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[TimeOnPageFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TimeOnPageFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ TimeOnPageResponse
+ Average time on page for the requested window and filters.
+
+ Examples
+ --------
+ import datetime
+
+ from webflow import Webflow
+
+ client = Webflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+ client.analyze.reports.time_on_page(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat(
+ "2026-04-01 00:00:00+00:00",
+ ),
+ end_time=datetime.datetime.fromisoformat(
+ "2026-04-08 00:00:00+00:00",
+ ),
+ metric_scope="session",
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+ )
+ """
+ _response = self._raw_client.time_on_page(
+ site_id,
+ start_time=start_time,
+ end_time=end_time,
+ metric_scope=metric_scope,
+ timeseries=timeseries,
+ device_type=device_type,
+ country=country,
+ page_path=page_path,
+ traffic_source=traffic_source,
+ referrer=referrer,
+ browser=browser,
+ utm_campaign=utm_campaign,
+ utm_medium=utm_medium,
+ utm_source=utm_source,
+ filter=filter,
+ request_options=request_options,
+ )
+ return _response.data
+
+ def scroll_depth(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ device_type: typing.Optional[ReportsScrollDepthRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[ScrollDepthFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> ScrollDepthResponse:
+ """
+ Returns the scroll-depth distribution for the site over a time window. Each row reports the scroll depth (in pixels) that a share of page views reached, at fixed breakpoints of 75%, 50%, and 25% of page views.
+
+ Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching. Omit `deviceType` to include all devices.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ device_type : typing.Optional[ReportsScrollDepthRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[ScrollDepthFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `ScrollDepthFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ ScrollDepthResponse
+ Scroll-depth distribution for the requested window and filters.
+
+ Examples
+ --------
+ import datetime
+
+ from webflow import Webflow
+
+ client = Webflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+ client.analyze.reports.scroll_depth(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat(
+ "2026-04-01 00:00:00+00:00",
+ ),
+ end_time=datetime.datetime.fromisoformat(
+ "2026-04-08 00:00:00+00:00",
+ ),
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+ )
+ """
+ _response = self._raw_client.scroll_depth(
+ site_id,
+ start_time=start_time,
+ end_time=end_time,
+ device_type=device_type,
+ country=country,
+ page_path=page_path,
+ traffic_source=traffic_source,
+ referrer=referrer,
+ browser=browser,
+ utm_campaign=utm_campaign,
+ utm_medium=utm_medium,
+ utm_source=utm_source,
+ filter=filter,
+ request_options=request_options,
+ )
+ return _response.data
+
+ def browser_window_height(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ device_type: typing.Optional[ReportsBrowserWindowHeightRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[BrowserWindowHeightFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> BrowserWindowHeightResponse:
+ """
+ Returns the average browser window height (in CSS pixels) for the site over a time window. The response wraps the single aggregate in a one-element `data` array for SDK uniformity with other Analyze reports.
+
+ Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching. Omit `deviceType` to include all devices.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ device_type : typing.Optional[ReportsBrowserWindowHeightRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[BrowserWindowHeightFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `BrowserWindowHeightFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ BrowserWindowHeightResponse
+ Average browser window height for the requested window and filters.
+
+ Examples
+ --------
+ import datetime
+
+ from webflow import Webflow
+
+ client = Webflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+ client.analyze.reports.browser_window_height(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat(
+ "2026-04-01 00:00:00+00:00",
+ ),
+ end_time=datetime.datetime.fromisoformat(
+ "2026-04-08 00:00:00+00:00",
+ ),
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+ )
+ """
+ _response = self._raw_client.browser_window_height(
+ site_id,
+ start_time=start_time,
+ end_time=end_time,
+ device_type=device_type,
+ country=country,
+ page_path=page_path,
+ traffic_source=traffic_source,
+ referrer=referrer,
+ browser=browser,
+ utm_campaign=utm_campaign,
+ utm_medium=utm_medium,
+ utm_source=utm_source,
+ filter=filter,
+ request_options=request_options,
+ )
+ return _response.data
+
+ def page_flow(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ direction: PageFlowDirection,
+ metric_scope: PageFlowMetricScope,
+ page_id: str,
+ collection_id: typing.Optional[str] = None,
+ item_slug: typing.Optional[str] = None,
+ limit: typing.Optional[int] = None,
+ device_type: typing.Optional[ReportsPageFlowRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[PageFlowFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> PageFlowResponse:
+ """
+ Returns the pages visitors viewed immediately before or after a required anchor page over a time window, ranked by sessions, users, or page views.
+
+ For a CMS template instance, provide both `collectionId` and `itemSlug` with `pageId`. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ direction : PageFlowDirection
+ Whether to return pages viewed immediately before or after the anchor page.
+
+ metric_scope : PageFlowMetricScope
+ The unit each row's `count` is measured in.
+
+ page_id : str
+ Identifier of the anchor Webflow page.
+
+ collection_id : typing.Optional[str]
+ Identifier of the CMS collection for an anchor template-page instance. Must be provided together with `itemSlug`, or both must be omitted.
+
+ item_slug : typing.Optional[str]
+ Slug of the CMS item for an anchor template-page instance. Must be provided together with `collectionId`, or both must be omitted.
+
+ limit : typing.Optional[int]
+ Maximum number of rows to return. Defaults to `10`, up to a maximum of `100`.
+
+ device_type : typing.Optional[ReportsPageFlowRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[PageFlowFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `PageFlowFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ PageFlowResponse
+ Pages viewed immediately before or after the anchor page, ranked by `count`.
+
+ Examples
+ --------
+ import datetime
+
+ from webflow import Webflow
+
+ client = Webflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+ client.analyze.reports.page_flow(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat(
+ "2026-04-01 00:00:00+00:00",
+ ),
+ end_time=datetime.datetime.fromisoformat(
+ "2026-04-08 00:00:00+00:00",
+ ),
+ direction="previous",
+ metric_scope="session",
+ page_id="65f1b2c4a8d3e5f7a9c1b2d3",
+ collection_id="66abc1234567890abcdef012",
+ item_slug="anchor-post",
+ limit=1,
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+ )
+ """
+ _response = self._raw_client.page_flow(
+ site_id,
+ start_time=start_time,
+ end_time=end_time,
+ direction=direction,
+ metric_scope=metric_scope,
+ page_id=page_id,
+ collection_id=collection_id,
+ item_slug=item_slug,
+ limit=limit,
+ device_type=device_type,
+ country=country,
+ page_path=page_path,
+ traffic_source=traffic_source,
+ referrer=referrer,
+ browser=browser,
+ utm_campaign=utm_campaign,
+ utm_medium=utm_medium,
+ utm_source=utm_source,
+ filter=filter,
+ request_options=request_options,
+ )
+ return _response.data
+
+
+class AsyncReportsClient:
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
+ self._raw_client = AsyncRawReportsClient(client_wrapper=client_wrapper)
+
+ @property
+ def with_raw_response(self) -> AsyncRawReportsClient:
+ """
+ Retrieves a raw implementation of this client that returns raw responses.
+
+ Returns
+ -------
+ AsyncRawReportsClient
+ """
+ return self._raw_client
+
+ async def traffic(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ metric_scope: TrafficMetricScope,
+ bucket_time_zone: AnalyzeBucketTimeZone,
+ device_type: typing.Optional[ReportsTrafficRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[TrafficFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> TrafficResponse:
+ """
+ Returns a daily time series of a single metric — sessions, users, or page views — over a time window.
+
+ Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ metric_scope : TrafficMetricScope
+ The unit each `count` data point is measured in.
+
+ bucket_time_zone : AnalyzeBucketTimeZone
+ IANA time zone used to align daily bucket boundaries.
+
+ device_type : typing.Optional[ReportsTrafficRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[TrafficFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TrafficFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ TrafficResponse
+ Time-series traffic report for the requested window and filters.
+
+ Examples
+ --------
+ import asyncio
+ import datetime
+
+ from webflow import AsyncWebflow
+
+ client = AsyncWebflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+
+
+ async def main() -> None:
+ await client.analyze.reports.traffic(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat(
+ "2026-04-01 00:00:00+00:00",
+ ),
+ end_time=datetime.datetime.fromisoformat(
+ "2026-04-08 00:00:00+00:00",
+ ),
+ metric_scope="session",
+ bucket_time_zone="America/New_York",
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+ )
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.traffic(
+ site_id,
+ start_time=start_time,
+ end_time=end_time,
+ metric_scope=metric_scope,
+ bucket_time_zone=bucket_time_zone,
+ device_type=device_type,
+ country=country,
+ page_path=page_path,
+ traffic_source=traffic_source,
+ referrer=referrer,
+ browser=browser,
+ utm_campaign=utm_campaign,
+ utm_medium=utm_medium,
+ utm_source=utm_source,
+ filter=filter,
+ request_options=request_options,
+ )
+ return _response.data
+
+ async def top_pages(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ sort_by: typing.Optional[TopPagesSortBy] = None,
+ limit: typing.Optional[int] = None,
+ timeseries: typing.Optional[AnalyzeDailyTimeseriesQuery] = None,
+ device_type: typing.Optional[ReportsTopPagesRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[TopPagesFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> TopPagesResponse:
+ """
+ Returns the most-visited pages over a time window, ranked by `sortBy` (sessions, users, or page views).
+
+ Each row carries all three scope counts; `sortBy` only governs ordering. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ Set `timeseries[bucketTimeZone]` to attach a daily page view `timeseries` to each row. Bucket counts are always page views regardless of `sortBy`. Row-level counts honor the requested sort, but the timeseries does not.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ sort_by : typing.Optional[TopPagesSortBy]
+ Metric used to rank rows in the response, descending. Defaults to `session`.
+
+ limit : typing.Optional[int]
+ Maximum number of rows to return. Defaults to `25`, up to a maximum of `250`.
+
+ timeseries : typing.Optional[AnalyzeDailyTimeseriesQuery]
+ Include a daily page view `timeseries` for each row, bucketed in the supplied IANA time zone. Omit this parameter to return ranked rows without per-page timeseries data.
+
+ device_type : typing.Optional[ReportsTopPagesRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[TopPagesFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TopPagesFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ TopPagesResponse
+ Pages ranked by `sortBy` for the requested window and filters.
+
+ Examples
+ --------
+ import asyncio
+ import datetime
+
+ from webflow import AsyncWebflow
+
+ client = AsyncWebflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+
+
+ async def main() -> None:
+ await client.analyze.reports.top_pages(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat(
+ "2026-04-01 00:00:00+00:00",
+ ),
+ end_time=datetime.datetime.fromisoformat(
+ "2026-04-08 00:00:00+00:00",
+ ),
+ sort_by="session",
+ limit=1,
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+ )
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.top_pages(
+ site_id,
+ start_time=start_time,
+ end_time=end_time,
+ sort_by=sort_by,
+ limit=limit,
+ timeseries=timeseries,
+ device_type=device_type,
+ country=country,
+ page_path=page_path,
+ traffic_source=traffic_source,
+ referrer=referrer,
+ browser=browser,
+ utm_campaign=utm_campaign,
+ utm_medium=utm_medium,
+ utm_source=utm_source,
+ filter=filter,
+ request_options=request_options,
+ )
+ return _response.data
+
+ async def top_dimensions(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ dimension: TopDimensionsDimension,
+ metric_scope: TopDimensionsMetricScope,
+ limit: typing.Optional[int] = None,
+ device_type: typing.Optional[ReportsTopDimensionsRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[TopDimensionsFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> TopDimensionsResponse:
+ """
+ Returns the top values within a chosen `dimension` — top countries, top traffic sources, top campaigns, top audiences, and so on — over a time window, ranked by sessions or users.
+
+ Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ dimension : TopDimensionsDimension
+ The dimension whose top values are ranked. See `TopDimensionsDimension` for the supported values.
+
+ metric_scope : TopDimensionsMetricScope
+ The unit each row's `count` is measured in — sessions or users.
+
+ limit : typing.Optional[int]
+ Maximum number of rows to return. Defaults to `25`, up to a maximum of `100`.
+
+ device_type : typing.Optional[ReportsTopDimensionsRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[TopDimensionsFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TopDimensionsFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ TopDimensionsResponse
+ Dimension values ranked by `count` for the requested window and filters.
+
+ Examples
+ --------
+ import asyncio
+ import datetime
+
+ from webflow import AsyncWebflow
+
+ client = AsyncWebflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+
+
+ async def main() -> None:
+ await client.analyze.reports.top_dimensions(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat(
+ "2026-04-01 00:00:00+00:00",
+ ),
+ end_time=datetime.datetime.fromisoformat(
+ "2026-04-08 00:00:00+00:00",
+ ),
+ dimension="country",
+ metric_scope="session",
+ limit=1,
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+ )
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.top_dimensions(
+ site_id,
+ start_time=start_time,
+ end_time=end_time,
+ dimension=dimension,
+ metric_scope=metric_scope,
+ limit=limit,
+ device_type=device_type,
+ country=country,
+ page_path=page_path,
+ traffic_source=traffic_source,
+ referrer=referrer,
+ browser=browser,
+ utm_campaign=utm_campaign,
+ utm_medium=utm_medium,
+ utm_source=utm_source,
+ filter=filter,
+ request_options=request_options,
+ )
+ return _response.data
+
+ async def top_events(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ limit: typing.Optional[int] = None,
+ timeseries: typing.Optional[AnalyzeDailyTimeseriesQuery] = None,
+ device_type: typing.Optional[ReportsTopEventsRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[TopEventsFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> TopEventsResponse:
+ """
+ Returns the top events over a time window, ranked by how often they occurred.
+
+ Events are counted individually, not rolled up into sessions, users, or page views — so this report has no `metricScope`. Each row's `count` is how many times the event occurred. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ Set `timeseries[bucketTimeZone]` to attach a daily event count `timeseries` to each row.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ limit : typing.Optional[int]
+ Maximum number of rows to return. Defaults to `25`, up to a maximum of `250`.
+
+ timeseries : typing.Optional[AnalyzeDailyTimeseriesQuery]
+ Include a daily event count `timeseries` for each row, bucketed in the supplied IANA time zone. Omit this parameter to return ranked rows without per-event timeseries data.
+
+ device_type : typing.Optional[ReportsTopEventsRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[TopEventsFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TopEventsFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ TopEventsResponse
+ Events ranked by how frequently they occurred, for the requested window and filters.
+
+ Examples
+ --------
+ import asyncio
+ import datetime
+
+ from webflow import AsyncWebflow
+
+ client = AsyncWebflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+
+
+ async def main() -> None:
+ await client.analyze.reports.top_events(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat(
+ "2026-04-01 00:00:00+00:00",
+ ),
+ end_time=datetime.datetime.fromisoformat(
+ "2026-04-08 00:00:00+00:00",
+ ),
+ limit=1,
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+ )
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.top_events(
+ site_id,
+ start_time=start_time,
+ end_time=end_time,
+ limit=limit,
+ timeseries=timeseries,
+ device_type=device_type,
+ country=country,
+ page_path=page_path,
+ traffic_source=traffic_source,
+ browser=browser,
+ utm_campaign=utm_campaign,
+ utm_medium=utm_medium,
+ utm_source=utm_source,
+ filter=filter,
+ request_options=request_options,
+ )
+ return _response.data
+
+ async def time_on_page(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ metric_scope: TimeOnPageMetricScope,
+ timeseries: typing.Optional[TimeOnPageTimeseriesQuery] = None,
+ device_type: typing.Optional[ReportsTimeOnPageRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[TimeOnPageFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> TimeOnPageResponse:
+ """
+ Returns the average time on page over a time window — as a single aggregate value, or bucketed by day or week when `timeseries` is supplied.
+
+ Choose how the average is computed with `metricScope` (per session, user, or page view). Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ metric_scope : TimeOnPageMetricScope
+ How the average time on page is computed — per session, user, or page view.
+
+ timeseries : typing.Optional[TimeOnPageTimeseriesQuery]
+ Include bucketed average time data using the supplied granularity and IANA time zone. Omit this parameter to return a single aggregate value for the requested window.
+
+ device_type : typing.Optional[ReportsTimeOnPageRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[TimeOnPageFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TimeOnPageFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ TimeOnPageResponse
+ Average time on page for the requested window and filters.
+
+ Examples
+ --------
+ import asyncio
+ import datetime
+
+ from webflow import AsyncWebflow
+
+ client = AsyncWebflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+
+
+ async def main() -> None:
+ await client.analyze.reports.time_on_page(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat(
+ "2026-04-01 00:00:00+00:00",
+ ),
+ end_time=datetime.datetime.fromisoformat(
+ "2026-04-08 00:00:00+00:00",
+ ),
+ metric_scope="session",
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+ )
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.time_on_page(
+ site_id,
+ start_time=start_time,
+ end_time=end_time,
+ metric_scope=metric_scope,
+ timeseries=timeseries,
+ device_type=device_type,
+ country=country,
+ page_path=page_path,
+ traffic_source=traffic_source,
+ referrer=referrer,
+ browser=browser,
+ utm_campaign=utm_campaign,
+ utm_medium=utm_medium,
+ utm_source=utm_source,
+ filter=filter,
+ request_options=request_options,
+ )
+ return _response.data
+
+ async def scroll_depth(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ device_type: typing.Optional[ReportsScrollDepthRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[ScrollDepthFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> ScrollDepthResponse:
+ """
+ Returns the scroll-depth distribution for the site over a time window. Each row reports the scroll depth (in pixels) that a share of page views reached, at fixed breakpoints of 75%, 50%, and 25% of page views.
+
+ Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching. Omit `deviceType` to include all devices.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ device_type : typing.Optional[ReportsScrollDepthRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[ScrollDepthFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `ScrollDepthFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ ScrollDepthResponse
+ Scroll-depth distribution for the requested window and filters.
+
+ Examples
+ --------
+ import asyncio
+ import datetime
+
+ from webflow import AsyncWebflow
+
+ client = AsyncWebflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+
+
+ async def main() -> None:
+ await client.analyze.reports.scroll_depth(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat(
+ "2026-04-01 00:00:00+00:00",
+ ),
+ end_time=datetime.datetime.fromisoformat(
+ "2026-04-08 00:00:00+00:00",
+ ),
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+ )
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.scroll_depth(
+ site_id,
+ start_time=start_time,
+ end_time=end_time,
+ device_type=device_type,
+ country=country,
+ page_path=page_path,
+ traffic_source=traffic_source,
+ referrer=referrer,
+ browser=browser,
+ utm_campaign=utm_campaign,
+ utm_medium=utm_medium,
+ utm_source=utm_source,
+ filter=filter,
+ request_options=request_options,
+ )
+ return _response.data
+
+ async def browser_window_height(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ device_type: typing.Optional[ReportsBrowserWindowHeightRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[BrowserWindowHeightFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> BrowserWindowHeightResponse:
+ """
+ Returns the average browser window height (in CSS pixels) for the site over a time window. The response wraps the single aggregate in a one-element `data` array for SDK uniformity with other Analyze reports.
+
+ Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching. Omit `deviceType` to include all devices.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ device_type : typing.Optional[ReportsBrowserWindowHeightRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[BrowserWindowHeightFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `BrowserWindowHeightFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ BrowserWindowHeightResponse
+ Average browser window height for the requested window and filters.
+
+ Examples
+ --------
+ import asyncio
+ import datetime
+
+ from webflow import AsyncWebflow
+
+ client = AsyncWebflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+
+
+ async def main() -> None:
+ await client.analyze.reports.browser_window_height(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat(
+ "2026-04-01 00:00:00+00:00",
+ ),
+ end_time=datetime.datetime.fromisoformat(
+ "2026-04-08 00:00:00+00:00",
+ ),
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+ )
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.browser_window_height(
+ site_id,
+ start_time=start_time,
+ end_time=end_time,
+ device_type=device_type,
+ country=country,
+ page_path=page_path,
+ traffic_source=traffic_source,
+ referrer=referrer,
+ browser=browser,
+ utm_campaign=utm_campaign,
+ utm_medium=utm_medium,
+ utm_source=utm_source,
+ filter=filter,
+ request_options=request_options,
+ )
+ return _response.data
+
+ async def page_flow(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ direction: PageFlowDirection,
+ metric_scope: PageFlowMetricScope,
+ page_id: str,
+ collection_id: typing.Optional[str] = None,
+ item_slug: typing.Optional[str] = None,
+ limit: typing.Optional[int] = None,
+ device_type: typing.Optional[ReportsPageFlowRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[PageFlowFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> PageFlowResponse:
+ """
+ Returns the pages visitors viewed immediately before or after a required anchor page over a time window, ranked by sessions, users, or page views.
+
+ For a CMS template instance, provide both `collectionId` and `itemSlug` with `pageId`. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ direction : PageFlowDirection
+ Whether to return pages viewed immediately before or after the anchor page.
+
+ metric_scope : PageFlowMetricScope
+ The unit each row's `count` is measured in.
+
+ page_id : str
+ Identifier of the anchor Webflow page.
+
+ collection_id : typing.Optional[str]
+ Identifier of the CMS collection for an anchor template-page instance. Must be provided together with `itemSlug`, or both must be omitted.
+
+ item_slug : typing.Optional[str]
+ Slug of the CMS item for an anchor template-page instance. Must be provided together with `collectionId`, or both must be omitted.
+
+ limit : typing.Optional[int]
+ Maximum number of rows to return. Defaults to `10`, up to a maximum of `100`.
+
+ device_type : typing.Optional[ReportsPageFlowRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[PageFlowFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `PageFlowFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ PageFlowResponse
+ Pages viewed immediately before or after the anchor page, ranked by `count`.
+
+ Examples
+ --------
+ import asyncio
+ import datetime
+
+ from webflow import AsyncWebflow
+
+ client = AsyncWebflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+
+
+ async def main() -> None:
+ await client.analyze.reports.page_flow(
+ site_id="580e63e98c9a982ac9b8b741",
+ start_time=datetime.datetime.fromisoformat(
+ "2026-04-01 00:00:00+00:00",
+ ),
+ end_time=datetime.datetime.fromisoformat(
+ "2026-04-08 00:00:00+00:00",
+ ),
+ direction="previous",
+ metric_scope="session",
+ page_id="65f1b2c4a8d3e5f7a9c1b2d3",
+ collection_id="66abc1234567890abcdef012",
+ item_slug="anchor-post",
+ limit=1,
+ device_type="desktop",
+ country="US",
+ page_path="/towels",
+ traffic_source="SO",
+ referrer="google.com",
+ browser="Chrome",
+ utm_campaign="dont-panic-2026",
+ utm_medium="email",
+ utm_source="hitchhikers-guide",
+ )
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.page_flow(
+ site_id,
+ start_time=start_time,
+ end_time=end_time,
+ direction=direction,
+ metric_scope=metric_scope,
+ page_id=page_id,
+ collection_id=collection_id,
+ item_slug=item_slug,
+ limit=limit,
+ device_type=device_type,
+ country=country,
+ page_path=page_path,
+ traffic_source=traffic_source,
+ referrer=referrer,
+ browser=browser,
+ utm_campaign=utm_campaign,
+ utm_medium=utm_medium,
+ utm_source=utm_source,
+ filter=filter,
+ request_options=request_options,
+ )
+ return _response.data
diff --git a/src/webflow/resources/analyze/resources/reports/raw_client.py b/src/webflow/resources/analyze/resources/reports/raw_client.py
new file mode 100644
index 00000000..3f6e3a03
--- /dev/null
+++ b/src/webflow/resources/analyze/resources/reports/raw_client.py
@@ -0,0 +1,3233 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+from json.decoder import JSONDecodeError
+
+from .....core.api_error import ApiError
+from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .....core.datetime_utils import serialize_datetime
+from .....core.http_response import AsyncHttpResponse, HttpResponse
+from .....core.jsonable_encoder import jsonable_encoder
+from .....core.parse_error import ParsingError
+from .....core.pydantic_utilities import parse_obj_as
+from .....core.request_options import RequestOptions
+from .....core.serialization import convert_and_respect_annotation_metadata
+from .....errors.bad_request_error import BadRequestError
+from .....errors.forbidden_error import ForbiddenError
+from .....errors.internal_server_error import InternalServerError
+from .....errors.not_found_error import NotFoundError
+from .....errors.too_many_requests_error import TooManyRequestsError
+from .....errors.unauthorized_error import UnauthorizedError
+from .....types.analyze_bucket_time_zone import AnalyzeBucketTimeZone
+from .....types.analyze_daily_timeseries_query import AnalyzeDailyTimeseriesQuery
+from .....types.browser_window_height_filter import BrowserWindowHeightFilter
+from .....types.browser_window_height_response import BrowserWindowHeightResponse
+from .....types.error import Error
+from .....types.page_flow_direction import PageFlowDirection
+from .....types.page_flow_filter import PageFlowFilter
+from .....types.page_flow_metric_scope import PageFlowMetricScope
+from .....types.page_flow_response import PageFlowResponse
+from .....types.scroll_depth_filter import ScrollDepthFilter
+from .....types.scroll_depth_response import ScrollDepthResponse
+from .....types.time_on_page_filter import TimeOnPageFilter
+from .....types.time_on_page_metric_scope import TimeOnPageMetricScope
+from .....types.time_on_page_response import TimeOnPageResponse
+from .....types.time_on_page_timeseries_query import TimeOnPageTimeseriesQuery
+from .....types.top_dimensions_dimension import TopDimensionsDimension
+from .....types.top_dimensions_filter import TopDimensionsFilter
+from .....types.top_dimensions_metric_scope import TopDimensionsMetricScope
+from .....types.top_dimensions_response import TopDimensionsResponse
+from .....types.top_events_filter import TopEventsFilter
+from .....types.top_events_response import TopEventsResponse
+from .....types.top_pages_filter import TopPagesFilter
+from .....types.top_pages_response import TopPagesResponse
+from .....types.top_pages_sort_by import TopPagesSortBy
+from .....types.traffic_filter import TrafficFilter
+from .....types.traffic_metric_scope import TrafficMetricScope
+from .....types.traffic_response import TrafficResponse
+from .types.reports_browser_window_height_request_device_type import ReportsBrowserWindowHeightRequestDeviceType
+from .types.reports_page_flow_request_device_type import ReportsPageFlowRequestDeviceType
+from .types.reports_scroll_depth_request_device_type import ReportsScrollDepthRequestDeviceType
+from .types.reports_time_on_page_request_device_type import ReportsTimeOnPageRequestDeviceType
+from .types.reports_top_dimensions_request_device_type import ReportsTopDimensionsRequestDeviceType
+from .types.reports_top_events_request_device_type import ReportsTopEventsRequestDeviceType
+from .types.reports_top_pages_request_device_type import ReportsTopPagesRequestDeviceType
+from .types.reports_traffic_request_device_type import ReportsTrafficRequestDeviceType
+from pydantic import ValidationError
+
+
+class RawReportsClient:
+ def __init__(self, *, client_wrapper: SyncClientWrapper):
+ self._client_wrapper = client_wrapper
+
+ def traffic(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ metric_scope: TrafficMetricScope,
+ bucket_time_zone: AnalyzeBucketTimeZone,
+ device_type: typing.Optional[ReportsTrafficRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[TrafficFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> HttpResponse[TrafficResponse]:
+ """
+ Returns a daily time series of a single metric — sessions, users, or page views — over a time window.
+
+ Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ metric_scope : TrafficMetricScope
+ The unit each `count` data point is measured in.
+
+ bucket_time_zone : AnalyzeBucketTimeZone
+ IANA time zone used to align daily bucket boundaries.
+
+ device_type : typing.Optional[ReportsTrafficRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[TrafficFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TrafficFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[TrafficResponse]
+ Time-series traffic report for the requested window and filters.
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ f"sites/{jsonable_encoder(site_id)}/analyze/reports/traffic",
+ base_url=self._client_wrapper.get_environment().base,
+ method="GET",
+ params={
+ "startTime": serialize_datetime(start_time),
+ "endTime": serialize_datetime(end_time),
+ "metricScope": metric_scope,
+ "bucketTimeZone": bucket_time_zone,
+ "deviceType": device_type,
+ "country": country,
+ "pagePath": page_path,
+ "trafficSource": traffic_source,
+ "referrer": referrer,
+ "browser": browser,
+ "utmCampaign": utm_campaign,
+ "utmMedium": utm_medium,
+ "utmSource": utm_source,
+ "filter": convert_and_respect_annotation_metadata(
+ object_=filter, annotation=TrafficFilter, direction="write"
+ ),
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ TrafficResponse,
+ parse_obj_as(
+ type_=TrafficResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ def top_pages(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ sort_by: typing.Optional[TopPagesSortBy] = None,
+ limit: typing.Optional[int] = None,
+ timeseries: typing.Optional[AnalyzeDailyTimeseriesQuery] = None,
+ device_type: typing.Optional[ReportsTopPagesRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[TopPagesFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> HttpResponse[TopPagesResponse]:
+ """
+ Returns the most-visited pages over a time window, ranked by `sortBy` (sessions, users, or page views).
+
+ Each row carries all three scope counts; `sortBy` only governs ordering. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ Set `timeseries[bucketTimeZone]` to attach a daily page view `timeseries` to each row. Bucket counts are always page views regardless of `sortBy`. Row-level counts honor the requested sort, but the timeseries does not.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ sort_by : typing.Optional[TopPagesSortBy]
+ Metric used to rank rows in the response, descending. Defaults to `session`.
+
+ limit : typing.Optional[int]
+ Maximum number of rows to return. Defaults to `25`, up to a maximum of `250`.
+
+ timeseries : typing.Optional[AnalyzeDailyTimeseriesQuery]
+ Include a daily page view `timeseries` for each row, bucketed in the supplied IANA time zone. Omit this parameter to return ranked rows without per-page timeseries data.
+
+ device_type : typing.Optional[ReportsTopPagesRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[TopPagesFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TopPagesFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[TopPagesResponse]
+ Pages ranked by `sortBy` for the requested window and filters.
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ f"sites/{jsonable_encoder(site_id)}/analyze/reports/top_pages",
+ base_url=self._client_wrapper.get_environment().base,
+ method="GET",
+ params={
+ "startTime": serialize_datetime(start_time),
+ "endTime": serialize_datetime(end_time),
+ "sortBy": sort_by,
+ "limit": limit,
+ "timeseries": convert_and_respect_annotation_metadata(
+ object_=timeseries, annotation=AnalyzeDailyTimeseriesQuery, direction="write"
+ ),
+ "deviceType": device_type,
+ "country": country,
+ "pagePath": page_path,
+ "trafficSource": traffic_source,
+ "referrer": referrer,
+ "browser": browser,
+ "utmCampaign": utm_campaign,
+ "utmMedium": utm_medium,
+ "utmSource": utm_source,
+ "filter": convert_and_respect_annotation_metadata(
+ object_=filter, annotation=TopPagesFilter, direction="write"
+ ),
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ TopPagesResponse,
+ parse_obj_as(
+ type_=TopPagesResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ def top_dimensions(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ dimension: TopDimensionsDimension,
+ metric_scope: TopDimensionsMetricScope,
+ limit: typing.Optional[int] = None,
+ device_type: typing.Optional[ReportsTopDimensionsRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[TopDimensionsFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> HttpResponse[TopDimensionsResponse]:
+ """
+ Returns the top values within a chosen `dimension` — top countries, top traffic sources, top campaigns, top audiences, and so on — over a time window, ranked by sessions or users.
+
+ Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ dimension : TopDimensionsDimension
+ The dimension whose top values are ranked. See `TopDimensionsDimension` for the supported values.
+
+ metric_scope : TopDimensionsMetricScope
+ The unit each row's `count` is measured in — sessions or users.
+
+ limit : typing.Optional[int]
+ Maximum number of rows to return. Defaults to `25`, up to a maximum of `100`.
+
+ device_type : typing.Optional[ReportsTopDimensionsRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[TopDimensionsFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TopDimensionsFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[TopDimensionsResponse]
+ Dimension values ranked by `count` for the requested window and filters.
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ f"sites/{jsonable_encoder(site_id)}/analyze/reports/top_dimensions",
+ base_url=self._client_wrapper.get_environment().base,
+ method="GET",
+ params={
+ "startTime": serialize_datetime(start_time),
+ "endTime": serialize_datetime(end_time),
+ "dimension": dimension,
+ "metricScope": metric_scope,
+ "limit": limit,
+ "deviceType": device_type,
+ "country": country,
+ "pagePath": page_path,
+ "trafficSource": traffic_source,
+ "referrer": referrer,
+ "browser": browser,
+ "utmCampaign": utm_campaign,
+ "utmMedium": utm_medium,
+ "utmSource": utm_source,
+ "filter": convert_and_respect_annotation_metadata(
+ object_=filter, annotation=TopDimensionsFilter, direction="write"
+ ),
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ TopDimensionsResponse,
+ parse_obj_as(
+ type_=TopDimensionsResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ def top_events(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ limit: typing.Optional[int] = None,
+ timeseries: typing.Optional[AnalyzeDailyTimeseriesQuery] = None,
+ device_type: typing.Optional[ReportsTopEventsRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[TopEventsFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> HttpResponse[TopEventsResponse]:
+ """
+ Returns the top events over a time window, ranked by how often they occurred.
+
+ Events are counted individually, not rolled up into sessions, users, or page views — so this report has no `metricScope`. Each row's `count` is how many times the event occurred. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ Set `timeseries[bucketTimeZone]` to attach a daily event count `timeseries` to each row.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ limit : typing.Optional[int]
+ Maximum number of rows to return. Defaults to `25`, up to a maximum of `250`.
+
+ timeseries : typing.Optional[AnalyzeDailyTimeseriesQuery]
+ Include a daily event count `timeseries` for each row, bucketed in the supplied IANA time zone. Omit this parameter to return ranked rows without per-event timeseries data.
+
+ device_type : typing.Optional[ReportsTopEventsRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[TopEventsFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TopEventsFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[TopEventsResponse]
+ Events ranked by how frequently they occurred, for the requested window and filters.
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ f"sites/{jsonable_encoder(site_id)}/analyze/reports/top_events",
+ base_url=self._client_wrapper.get_environment().base,
+ method="GET",
+ params={
+ "startTime": serialize_datetime(start_time),
+ "endTime": serialize_datetime(end_time),
+ "limit": limit,
+ "timeseries": convert_and_respect_annotation_metadata(
+ object_=timeseries, annotation=AnalyzeDailyTimeseriesQuery, direction="write"
+ ),
+ "deviceType": device_type,
+ "country": country,
+ "pagePath": page_path,
+ "trafficSource": traffic_source,
+ "browser": browser,
+ "utmCampaign": utm_campaign,
+ "utmMedium": utm_medium,
+ "utmSource": utm_source,
+ "filter": convert_and_respect_annotation_metadata(
+ object_=filter, annotation=TopEventsFilter, direction="write"
+ ),
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ TopEventsResponse,
+ parse_obj_as(
+ type_=TopEventsResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ def time_on_page(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ metric_scope: TimeOnPageMetricScope,
+ timeseries: typing.Optional[TimeOnPageTimeseriesQuery] = None,
+ device_type: typing.Optional[ReportsTimeOnPageRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[TimeOnPageFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> HttpResponse[TimeOnPageResponse]:
+ """
+ Returns the average time on page over a time window — as a single aggregate value, or bucketed by day or week when `timeseries` is supplied.
+
+ Choose how the average is computed with `metricScope` (per session, user, or page view). Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ metric_scope : TimeOnPageMetricScope
+ How the average time on page is computed — per session, user, or page view.
+
+ timeseries : typing.Optional[TimeOnPageTimeseriesQuery]
+ Include bucketed average time data using the supplied granularity and IANA time zone. Omit this parameter to return a single aggregate value for the requested window.
+
+ device_type : typing.Optional[ReportsTimeOnPageRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[TimeOnPageFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TimeOnPageFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[TimeOnPageResponse]
+ Average time on page for the requested window and filters.
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ f"sites/{jsonable_encoder(site_id)}/analyze/reports/time_on_page",
+ base_url=self._client_wrapper.get_environment().base,
+ method="GET",
+ params={
+ "startTime": serialize_datetime(start_time),
+ "endTime": serialize_datetime(end_time),
+ "metricScope": metric_scope,
+ "timeseries": convert_and_respect_annotation_metadata(
+ object_=timeseries, annotation=TimeOnPageTimeseriesQuery, direction="write"
+ ),
+ "deviceType": device_type,
+ "country": country,
+ "pagePath": page_path,
+ "trafficSource": traffic_source,
+ "referrer": referrer,
+ "browser": browser,
+ "utmCampaign": utm_campaign,
+ "utmMedium": utm_medium,
+ "utmSource": utm_source,
+ "filter": convert_and_respect_annotation_metadata(
+ object_=filter, annotation=TimeOnPageFilter, direction="write"
+ ),
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ TimeOnPageResponse,
+ parse_obj_as(
+ type_=TimeOnPageResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ def scroll_depth(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ device_type: typing.Optional[ReportsScrollDepthRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[ScrollDepthFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> HttpResponse[ScrollDepthResponse]:
+ """
+ Returns the scroll-depth distribution for the site over a time window. Each row reports the scroll depth (in pixels) that a share of page views reached, at fixed breakpoints of 75%, 50%, and 25% of page views.
+
+ Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching. Omit `deviceType` to include all devices.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ device_type : typing.Optional[ReportsScrollDepthRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[ScrollDepthFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `ScrollDepthFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[ScrollDepthResponse]
+ Scroll-depth distribution for the requested window and filters.
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ f"sites/{jsonable_encoder(site_id)}/analyze/reports/scroll_depth",
+ base_url=self._client_wrapper.get_environment().base,
+ method="GET",
+ params={
+ "startTime": serialize_datetime(start_time),
+ "endTime": serialize_datetime(end_time),
+ "deviceType": device_type,
+ "country": country,
+ "pagePath": page_path,
+ "trafficSource": traffic_source,
+ "referrer": referrer,
+ "browser": browser,
+ "utmCampaign": utm_campaign,
+ "utmMedium": utm_medium,
+ "utmSource": utm_source,
+ "filter": convert_and_respect_annotation_metadata(
+ object_=filter, annotation=ScrollDepthFilter, direction="write"
+ ),
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ ScrollDepthResponse,
+ parse_obj_as(
+ type_=ScrollDepthResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ def browser_window_height(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ device_type: typing.Optional[ReportsBrowserWindowHeightRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[BrowserWindowHeightFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> HttpResponse[BrowserWindowHeightResponse]:
+ """
+ Returns the average browser window height (in CSS pixels) for the site over a time window. The response wraps the single aggregate in a one-element `data` array for SDK uniformity with other Analyze reports.
+
+ Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching. Omit `deviceType` to include all devices.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ device_type : typing.Optional[ReportsBrowserWindowHeightRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[BrowserWindowHeightFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `BrowserWindowHeightFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[BrowserWindowHeightResponse]
+ Average browser window height for the requested window and filters.
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ f"sites/{jsonable_encoder(site_id)}/analyze/reports/browser_window_height",
+ base_url=self._client_wrapper.get_environment().base,
+ method="GET",
+ params={
+ "startTime": serialize_datetime(start_time),
+ "endTime": serialize_datetime(end_time),
+ "deviceType": device_type,
+ "country": country,
+ "pagePath": page_path,
+ "trafficSource": traffic_source,
+ "referrer": referrer,
+ "browser": browser,
+ "utmCampaign": utm_campaign,
+ "utmMedium": utm_medium,
+ "utmSource": utm_source,
+ "filter": convert_and_respect_annotation_metadata(
+ object_=filter, annotation=BrowserWindowHeightFilter, direction="write"
+ ),
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ BrowserWindowHeightResponse,
+ parse_obj_as(
+ type_=BrowserWindowHeightResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ def page_flow(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ direction: PageFlowDirection,
+ metric_scope: PageFlowMetricScope,
+ page_id: str,
+ collection_id: typing.Optional[str] = None,
+ item_slug: typing.Optional[str] = None,
+ limit: typing.Optional[int] = None,
+ device_type: typing.Optional[ReportsPageFlowRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[PageFlowFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> HttpResponse[PageFlowResponse]:
+ """
+ Returns the pages visitors viewed immediately before or after a required anchor page over a time window, ranked by sessions, users, or page views.
+
+ For a CMS template instance, provide both `collectionId` and `itemSlug` with `pageId`. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ direction : PageFlowDirection
+ Whether to return pages viewed immediately before or after the anchor page.
+
+ metric_scope : PageFlowMetricScope
+ The unit each row's `count` is measured in.
+
+ page_id : str
+ Identifier of the anchor Webflow page.
+
+ collection_id : typing.Optional[str]
+ Identifier of the CMS collection for an anchor template-page instance. Must be provided together with `itemSlug`, or both must be omitted.
+
+ item_slug : typing.Optional[str]
+ Slug of the CMS item for an anchor template-page instance. Must be provided together with `collectionId`, or both must be omitted.
+
+ limit : typing.Optional[int]
+ Maximum number of rows to return. Defaults to `10`, up to a maximum of `100`.
+
+ device_type : typing.Optional[ReportsPageFlowRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[PageFlowFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `PageFlowFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[PageFlowResponse]
+ Pages viewed immediately before or after the anchor page, ranked by `count`.
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ f"sites/{jsonable_encoder(site_id)}/analyze/reports/page_flow",
+ base_url=self._client_wrapper.get_environment().base,
+ method="GET",
+ params={
+ "startTime": serialize_datetime(start_time),
+ "endTime": serialize_datetime(end_time),
+ "direction": direction,
+ "metricScope": metric_scope,
+ "pageId": page_id,
+ "collectionId": collection_id,
+ "itemSlug": item_slug,
+ "limit": limit,
+ "deviceType": device_type,
+ "country": country,
+ "pagePath": page_path,
+ "trafficSource": traffic_source,
+ "referrer": referrer,
+ "browser": browser,
+ "utmCampaign": utm_campaign,
+ "utmMedium": utm_medium,
+ "utmSource": utm_source,
+ "filter": convert_and_respect_annotation_metadata(
+ object_=filter, annotation=PageFlowFilter, direction="write"
+ ),
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ PageFlowResponse,
+ parse_obj_as(
+ type_=PageFlowResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawReportsClient:
+ def __init__(self, *, client_wrapper: AsyncClientWrapper):
+ self._client_wrapper = client_wrapper
+
+ async def traffic(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ metric_scope: TrafficMetricScope,
+ bucket_time_zone: AnalyzeBucketTimeZone,
+ device_type: typing.Optional[ReportsTrafficRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[TrafficFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> AsyncHttpResponse[TrafficResponse]:
+ """
+ Returns a daily time series of a single metric — sessions, users, or page views — over a time window.
+
+ Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ metric_scope : TrafficMetricScope
+ The unit each `count` data point is measured in.
+
+ bucket_time_zone : AnalyzeBucketTimeZone
+ IANA time zone used to align daily bucket boundaries.
+
+ device_type : typing.Optional[ReportsTrafficRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[TrafficFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TrafficFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[TrafficResponse]
+ Time-series traffic report for the requested window and filters.
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ f"sites/{jsonable_encoder(site_id)}/analyze/reports/traffic",
+ base_url=self._client_wrapper.get_environment().base,
+ method="GET",
+ params={
+ "startTime": serialize_datetime(start_time),
+ "endTime": serialize_datetime(end_time),
+ "metricScope": metric_scope,
+ "bucketTimeZone": bucket_time_zone,
+ "deviceType": device_type,
+ "country": country,
+ "pagePath": page_path,
+ "trafficSource": traffic_source,
+ "referrer": referrer,
+ "browser": browser,
+ "utmCampaign": utm_campaign,
+ "utmMedium": utm_medium,
+ "utmSource": utm_source,
+ "filter": convert_and_respect_annotation_metadata(
+ object_=filter, annotation=TrafficFilter, direction="write"
+ ),
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ TrafficResponse,
+ parse_obj_as(
+ type_=TrafficResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ async def top_pages(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ sort_by: typing.Optional[TopPagesSortBy] = None,
+ limit: typing.Optional[int] = None,
+ timeseries: typing.Optional[AnalyzeDailyTimeseriesQuery] = None,
+ device_type: typing.Optional[ReportsTopPagesRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[TopPagesFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> AsyncHttpResponse[TopPagesResponse]:
+ """
+ Returns the most-visited pages over a time window, ranked by `sortBy` (sessions, users, or page views).
+
+ Each row carries all three scope counts; `sortBy` only governs ordering. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ Set `timeseries[bucketTimeZone]` to attach a daily page view `timeseries` to each row. Bucket counts are always page views regardless of `sortBy`. Row-level counts honor the requested sort, but the timeseries does not.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ sort_by : typing.Optional[TopPagesSortBy]
+ Metric used to rank rows in the response, descending. Defaults to `session`.
+
+ limit : typing.Optional[int]
+ Maximum number of rows to return. Defaults to `25`, up to a maximum of `250`.
+
+ timeseries : typing.Optional[AnalyzeDailyTimeseriesQuery]
+ Include a daily page view `timeseries` for each row, bucketed in the supplied IANA time zone. Omit this parameter to return ranked rows without per-page timeseries data.
+
+ device_type : typing.Optional[ReportsTopPagesRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[TopPagesFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TopPagesFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[TopPagesResponse]
+ Pages ranked by `sortBy` for the requested window and filters.
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ f"sites/{jsonable_encoder(site_id)}/analyze/reports/top_pages",
+ base_url=self._client_wrapper.get_environment().base,
+ method="GET",
+ params={
+ "startTime": serialize_datetime(start_time),
+ "endTime": serialize_datetime(end_time),
+ "sortBy": sort_by,
+ "limit": limit,
+ "timeseries": convert_and_respect_annotation_metadata(
+ object_=timeseries, annotation=AnalyzeDailyTimeseriesQuery, direction="write"
+ ),
+ "deviceType": device_type,
+ "country": country,
+ "pagePath": page_path,
+ "trafficSource": traffic_source,
+ "referrer": referrer,
+ "browser": browser,
+ "utmCampaign": utm_campaign,
+ "utmMedium": utm_medium,
+ "utmSource": utm_source,
+ "filter": convert_and_respect_annotation_metadata(
+ object_=filter, annotation=TopPagesFilter, direction="write"
+ ),
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ TopPagesResponse,
+ parse_obj_as(
+ type_=TopPagesResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ async def top_dimensions(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ dimension: TopDimensionsDimension,
+ metric_scope: TopDimensionsMetricScope,
+ limit: typing.Optional[int] = None,
+ device_type: typing.Optional[ReportsTopDimensionsRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[TopDimensionsFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> AsyncHttpResponse[TopDimensionsResponse]:
+ """
+ Returns the top values within a chosen `dimension` — top countries, top traffic sources, top campaigns, top audiences, and so on — over a time window, ranked by sessions or users.
+
+ Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ dimension : TopDimensionsDimension
+ The dimension whose top values are ranked. See `TopDimensionsDimension` for the supported values.
+
+ metric_scope : TopDimensionsMetricScope
+ The unit each row's `count` is measured in — sessions or users.
+
+ limit : typing.Optional[int]
+ Maximum number of rows to return. Defaults to `25`, up to a maximum of `100`.
+
+ device_type : typing.Optional[ReportsTopDimensionsRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[TopDimensionsFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TopDimensionsFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[TopDimensionsResponse]
+ Dimension values ranked by `count` for the requested window and filters.
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ f"sites/{jsonable_encoder(site_id)}/analyze/reports/top_dimensions",
+ base_url=self._client_wrapper.get_environment().base,
+ method="GET",
+ params={
+ "startTime": serialize_datetime(start_time),
+ "endTime": serialize_datetime(end_time),
+ "dimension": dimension,
+ "metricScope": metric_scope,
+ "limit": limit,
+ "deviceType": device_type,
+ "country": country,
+ "pagePath": page_path,
+ "trafficSource": traffic_source,
+ "referrer": referrer,
+ "browser": browser,
+ "utmCampaign": utm_campaign,
+ "utmMedium": utm_medium,
+ "utmSource": utm_source,
+ "filter": convert_and_respect_annotation_metadata(
+ object_=filter, annotation=TopDimensionsFilter, direction="write"
+ ),
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ TopDimensionsResponse,
+ parse_obj_as(
+ type_=TopDimensionsResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ async def top_events(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ limit: typing.Optional[int] = None,
+ timeseries: typing.Optional[AnalyzeDailyTimeseriesQuery] = None,
+ device_type: typing.Optional[ReportsTopEventsRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[TopEventsFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> AsyncHttpResponse[TopEventsResponse]:
+ """
+ Returns the top events over a time window, ranked by how often they occurred.
+
+ Events are counted individually, not rolled up into sessions, users, or page views — so this report has no `metricScope`. Each row's `count` is how many times the event occurred. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ Set `timeseries[bucketTimeZone]` to attach a daily event count `timeseries` to each row.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ limit : typing.Optional[int]
+ Maximum number of rows to return. Defaults to `25`, up to a maximum of `250`.
+
+ timeseries : typing.Optional[AnalyzeDailyTimeseriesQuery]
+ Include a daily event count `timeseries` for each row, bucketed in the supplied IANA time zone. Omit this parameter to return ranked rows without per-event timeseries data.
+
+ device_type : typing.Optional[ReportsTopEventsRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[TopEventsFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TopEventsFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[TopEventsResponse]
+ Events ranked by how frequently they occurred, for the requested window and filters.
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ f"sites/{jsonable_encoder(site_id)}/analyze/reports/top_events",
+ base_url=self._client_wrapper.get_environment().base,
+ method="GET",
+ params={
+ "startTime": serialize_datetime(start_time),
+ "endTime": serialize_datetime(end_time),
+ "limit": limit,
+ "timeseries": convert_and_respect_annotation_metadata(
+ object_=timeseries, annotation=AnalyzeDailyTimeseriesQuery, direction="write"
+ ),
+ "deviceType": device_type,
+ "country": country,
+ "pagePath": page_path,
+ "trafficSource": traffic_source,
+ "browser": browser,
+ "utmCampaign": utm_campaign,
+ "utmMedium": utm_medium,
+ "utmSource": utm_source,
+ "filter": convert_and_respect_annotation_metadata(
+ object_=filter, annotation=TopEventsFilter, direction="write"
+ ),
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ TopEventsResponse,
+ parse_obj_as(
+ type_=TopEventsResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ async def time_on_page(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ metric_scope: TimeOnPageMetricScope,
+ timeseries: typing.Optional[TimeOnPageTimeseriesQuery] = None,
+ device_type: typing.Optional[ReportsTimeOnPageRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[TimeOnPageFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> AsyncHttpResponse[TimeOnPageResponse]:
+ """
+ Returns the average time on page over a time window — as a single aggregate value, or bucketed by day or week when `timeseries` is supplied.
+
+ Choose how the average is computed with `metricScope` (per session, user, or page view). Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ metric_scope : TimeOnPageMetricScope
+ How the average time on page is computed — per session, user, or page view.
+
+ timeseries : typing.Optional[TimeOnPageTimeseriesQuery]
+ Include bucketed average time data using the supplied granularity and IANA time zone. Omit this parameter to return a single aggregate value for the requested window.
+
+ device_type : typing.Optional[ReportsTimeOnPageRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[TimeOnPageFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TimeOnPageFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[TimeOnPageResponse]
+ Average time on page for the requested window and filters.
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ f"sites/{jsonable_encoder(site_id)}/analyze/reports/time_on_page",
+ base_url=self._client_wrapper.get_environment().base,
+ method="GET",
+ params={
+ "startTime": serialize_datetime(start_time),
+ "endTime": serialize_datetime(end_time),
+ "metricScope": metric_scope,
+ "timeseries": convert_and_respect_annotation_metadata(
+ object_=timeseries, annotation=TimeOnPageTimeseriesQuery, direction="write"
+ ),
+ "deviceType": device_type,
+ "country": country,
+ "pagePath": page_path,
+ "trafficSource": traffic_source,
+ "referrer": referrer,
+ "browser": browser,
+ "utmCampaign": utm_campaign,
+ "utmMedium": utm_medium,
+ "utmSource": utm_source,
+ "filter": convert_and_respect_annotation_metadata(
+ object_=filter, annotation=TimeOnPageFilter, direction="write"
+ ),
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ TimeOnPageResponse,
+ parse_obj_as(
+ type_=TimeOnPageResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ async def scroll_depth(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ device_type: typing.Optional[ReportsScrollDepthRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[ScrollDepthFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> AsyncHttpResponse[ScrollDepthResponse]:
+ """
+ Returns the scroll-depth distribution for the site over a time window. Each row reports the scroll depth (in pixels) that a share of page views reached, at fixed breakpoints of 75%, 50%, and 25% of page views.
+
+ Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching. Omit `deviceType` to include all devices.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ device_type : typing.Optional[ReportsScrollDepthRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[ScrollDepthFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `ScrollDepthFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[ScrollDepthResponse]
+ Scroll-depth distribution for the requested window and filters.
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ f"sites/{jsonable_encoder(site_id)}/analyze/reports/scroll_depth",
+ base_url=self._client_wrapper.get_environment().base,
+ method="GET",
+ params={
+ "startTime": serialize_datetime(start_time),
+ "endTime": serialize_datetime(end_time),
+ "deviceType": device_type,
+ "country": country,
+ "pagePath": page_path,
+ "trafficSource": traffic_source,
+ "referrer": referrer,
+ "browser": browser,
+ "utmCampaign": utm_campaign,
+ "utmMedium": utm_medium,
+ "utmSource": utm_source,
+ "filter": convert_and_respect_annotation_metadata(
+ object_=filter, annotation=ScrollDepthFilter, direction="write"
+ ),
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ ScrollDepthResponse,
+ parse_obj_as(
+ type_=ScrollDepthResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ async def browser_window_height(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ device_type: typing.Optional[ReportsBrowserWindowHeightRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[BrowserWindowHeightFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> AsyncHttpResponse[BrowserWindowHeightResponse]:
+ """
+ Returns the average browser window height (in CSS pixels) for the site over a time window. The response wraps the single aggregate in a one-element `data` array for SDK uniformity with other Analyze reports.
+
+ Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching. Omit `deviceType` to include all devices.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ device_type : typing.Optional[ReportsBrowserWindowHeightRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[BrowserWindowHeightFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `BrowserWindowHeightFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[BrowserWindowHeightResponse]
+ Average browser window height for the requested window and filters.
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ f"sites/{jsonable_encoder(site_id)}/analyze/reports/browser_window_height",
+ base_url=self._client_wrapper.get_environment().base,
+ method="GET",
+ params={
+ "startTime": serialize_datetime(start_time),
+ "endTime": serialize_datetime(end_time),
+ "deviceType": device_type,
+ "country": country,
+ "pagePath": page_path,
+ "trafficSource": traffic_source,
+ "referrer": referrer,
+ "browser": browser,
+ "utmCampaign": utm_campaign,
+ "utmMedium": utm_medium,
+ "utmSource": utm_source,
+ "filter": convert_and_respect_annotation_metadata(
+ object_=filter, annotation=BrowserWindowHeightFilter, direction="write"
+ ),
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ BrowserWindowHeightResponse,
+ parse_obj_as(
+ type_=BrowserWindowHeightResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ async def page_flow(
+ self,
+ site_id: str,
+ *,
+ start_time: dt.datetime,
+ end_time: dt.datetime,
+ direction: PageFlowDirection,
+ metric_scope: PageFlowMetricScope,
+ page_id: str,
+ collection_id: typing.Optional[str] = None,
+ item_slug: typing.Optional[str] = None,
+ limit: typing.Optional[int] = None,
+ device_type: typing.Optional[ReportsPageFlowRequestDeviceType] = None,
+ country: typing.Optional[str] = None,
+ page_path: typing.Optional[str] = None,
+ traffic_source: typing.Optional[str] = None,
+ referrer: typing.Optional[str] = None,
+ browser: typing.Optional[str] = None,
+ utm_campaign: typing.Optional[str] = None,
+ utm_medium: typing.Optional[str] = None,
+ utm_source: typing.Optional[str] = None,
+ filter: typing.Optional[PageFlowFilter] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> AsyncHttpResponse[PageFlowResponse]:
+ """
+ Returns the pages visitors viewed immediately before or after a required anchor page over a time window, ranked by sessions, users, or page views.
+
+ For a CMS template instance, provide both `collectionId` and `itemSlug` with `pageId`. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching.
+
+ This endpoint requires a workspace with the Analyze add-on.
+
+ Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`. Wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.
+
+ Required scope | `sites:read`
+
+ Parameters
+ ----------
+ site_id : str
+ Unique identifier for a Site
+
+ start_time : dt.datetime
+ Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-01T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be on or after `2025-04-09T00:00:00Z`.
+
+ end_time : dt.datetime
+ Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in `Z` (for example, `2026-04-08T00:00:00Z`); numeric offsets such as `-04:00` or `+00:00` are not accepted. Must be greater than `startTime` and within 100 days of it.
+
+ direction : PageFlowDirection
+ Whether to return pages viewed immediately before or after the anchor page.
+
+ metric_scope : PageFlowMetricScope
+ The unit each row's `count` is measured in.
+
+ page_id : str
+ Identifier of the anchor Webflow page.
+
+ collection_id : typing.Optional[str]
+ Identifier of the CMS collection for an anchor template-page instance. Must be provided together with `itemSlug`, or both must be omitted.
+
+ item_slug : typing.Optional[str]
+ Slug of the CMS item for an anchor template-page instance. Must be provided together with `collectionId`, or both must be omitted.
+
+ limit : typing.Optional[int]
+ Maximum number of rows to return. Defaults to `10`, up to a maximum of `100`.
+
+ device_type : typing.Optional[ReportsPageFlowRequestDeviceType]
+ Restrict the report to a single device type.
+
+ country : typing.Optional[str]
+ Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).
+
+ page_path : typing.Optional[str]
+ Restrict the report to a single page path.
+
+ traffic_source : typing.Optional[str]
+ Restrict the report to a single traffic source code (for example, `SO` for Organic Search).
+
+ referrer : typing.Optional[str]
+ Restrict the report to a single referrer domain.
+
+ browser : typing.Optional[str]
+ Restrict the report to a single browser.
+
+ utm_campaign : typing.Optional[str]
+ Restrict the report to a single `utm_campaign` value.
+
+ utm_medium : typing.Optional[str]
+ Restrict the report to a single `utm_medium` value.
+
+ utm_source : typing.Optional[str]
+ Restrict the report to a single `utm_source` value.
+
+ filter : typing.Optional[PageFlowFilter]
+ Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`).
+ Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `PageFlowFilter` schema for the full list of supported dimensions.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[PageFlowResponse]
+ Pages viewed immediately before or after the anchor page, ranked by `count`.
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ f"sites/{jsonable_encoder(site_id)}/analyze/reports/page_flow",
+ base_url=self._client_wrapper.get_environment().base,
+ method="GET",
+ params={
+ "startTime": serialize_datetime(start_time),
+ "endTime": serialize_datetime(end_time),
+ "direction": direction,
+ "metricScope": metric_scope,
+ "pageId": page_id,
+ "collectionId": collection_id,
+ "itemSlug": item_slug,
+ "limit": limit,
+ "deviceType": device_type,
+ "country": country,
+ "pagePath": page_path,
+ "trafficSource": traffic_source,
+ "referrer": referrer,
+ "browser": browser,
+ "utmCampaign": utm_campaign,
+ "utmMedium": utm_medium,
+ "utmSource": utm_source,
+ "filter": convert_and_respect_annotation_metadata(
+ object_=filter, annotation=PageFlowFilter, direction="write"
+ ),
+ },
+ request_options=request_options,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ PageFlowResponse,
+ parse_obj_as(
+ type_=PageFlowResponse, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 403:
+ raise ForbiddenError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
diff --git a/src/webflow/resources/analyze/resources/reports/types/__init__.py b/src/webflow/resources/analyze/resources/reports/types/__init__.py
new file mode 100644
index 00000000..f44dad1f
--- /dev/null
+++ b/src/webflow/resources/analyze/resources/reports/types/__init__.py
@@ -0,0 +1,59 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+ from .reports_browser_window_height_request_device_type import ReportsBrowserWindowHeightRequestDeviceType
+ from .reports_page_flow_request_device_type import ReportsPageFlowRequestDeviceType
+ from .reports_scroll_depth_request_device_type import ReportsScrollDepthRequestDeviceType
+ from .reports_time_on_page_request_device_type import ReportsTimeOnPageRequestDeviceType
+ from .reports_top_dimensions_request_device_type import ReportsTopDimensionsRequestDeviceType
+ from .reports_top_events_request_device_type import ReportsTopEventsRequestDeviceType
+ from .reports_top_pages_request_device_type import ReportsTopPagesRequestDeviceType
+ from .reports_traffic_request_device_type import ReportsTrafficRequestDeviceType
+_dynamic_imports: typing.Dict[str, str] = {
+ "ReportsBrowserWindowHeightRequestDeviceType": ".reports_browser_window_height_request_device_type",
+ "ReportsPageFlowRequestDeviceType": ".reports_page_flow_request_device_type",
+ "ReportsScrollDepthRequestDeviceType": ".reports_scroll_depth_request_device_type",
+ "ReportsTimeOnPageRequestDeviceType": ".reports_time_on_page_request_device_type",
+ "ReportsTopDimensionsRequestDeviceType": ".reports_top_dimensions_request_device_type",
+ "ReportsTopEventsRequestDeviceType": ".reports_top_events_request_device_type",
+ "ReportsTopPagesRequestDeviceType": ".reports_top_pages_request_device_type",
+ "ReportsTrafficRequestDeviceType": ".reports_traffic_request_device_type",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+ module_name = _dynamic_imports.get(attr_name)
+ if module_name is None:
+ raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+ try:
+ module = import_module(module_name, __package__)
+ if module_name == f".{attr_name}":
+ return module
+ else:
+ return getattr(module, attr_name)
+ except ImportError as e:
+ raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+ except AttributeError as e:
+ raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+ lazy_attrs = list(_dynamic_imports.keys())
+ return sorted(lazy_attrs)
+
+
+__all__ = [
+ "ReportsBrowserWindowHeightRequestDeviceType",
+ "ReportsPageFlowRequestDeviceType",
+ "ReportsScrollDepthRequestDeviceType",
+ "ReportsTimeOnPageRequestDeviceType",
+ "ReportsTopDimensionsRequestDeviceType",
+ "ReportsTopEventsRequestDeviceType",
+ "ReportsTopPagesRequestDeviceType",
+ "ReportsTrafficRequestDeviceType",
+]
diff --git a/src/webflow/resources/analyze/resources/reports/types/reports_browser_window_height_request_device_type.py b/src/webflow/resources/analyze/resources/reports/types/reports_browser_window_height_request_device_type.py
new file mode 100644
index 00000000..ebbfc71a
--- /dev/null
+++ b/src/webflow/resources/analyze/resources/reports/types/reports_browser_window_height_request_device_type.py
@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ReportsBrowserWindowHeightRequestDeviceType = typing.Union[typing.Literal["desktop", "mobile", "tablet"], typing.Any]
diff --git a/src/webflow/resources/analyze/resources/reports/types/reports_page_flow_request_device_type.py b/src/webflow/resources/analyze/resources/reports/types/reports_page_flow_request_device_type.py
new file mode 100644
index 00000000..f247e2ba
--- /dev/null
+++ b/src/webflow/resources/analyze/resources/reports/types/reports_page_flow_request_device_type.py
@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ReportsPageFlowRequestDeviceType = typing.Union[typing.Literal["desktop", "mobile", "tablet"], typing.Any]
diff --git a/src/webflow/resources/analyze/resources/reports/types/reports_scroll_depth_request_device_type.py b/src/webflow/resources/analyze/resources/reports/types/reports_scroll_depth_request_device_type.py
new file mode 100644
index 00000000..68516372
--- /dev/null
+++ b/src/webflow/resources/analyze/resources/reports/types/reports_scroll_depth_request_device_type.py
@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ReportsScrollDepthRequestDeviceType = typing.Union[typing.Literal["desktop", "mobile", "tablet"], typing.Any]
diff --git a/src/webflow/resources/analyze/resources/reports/types/reports_time_on_page_request_device_type.py b/src/webflow/resources/analyze/resources/reports/types/reports_time_on_page_request_device_type.py
new file mode 100644
index 00000000..26062d31
--- /dev/null
+++ b/src/webflow/resources/analyze/resources/reports/types/reports_time_on_page_request_device_type.py
@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ReportsTimeOnPageRequestDeviceType = typing.Union[typing.Literal["desktop", "mobile", "tablet"], typing.Any]
diff --git a/src/webflow/resources/analyze/resources/reports/types/reports_top_dimensions_request_device_type.py b/src/webflow/resources/analyze/resources/reports/types/reports_top_dimensions_request_device_type.py
new file mode 100644
index 00000000..be530225
--- /dev/null
+++ b/src/webflow/resources/analyze/resources/reports/types/reports_top_dimensions_request_device_type.py
@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ReportsTopDimensionsRequestDeviceType = typing.Union[typing.Literal["desktop", "mobile", "tablet"], typing.Any]
diff --git a/src/webflow/resources/analyze/resources/reports/types/reports_top_events_request_device_type.py b/src/webflow/resources/analyze/resources/reports/types/reports_top_events_request_device_type.py
new file mode 100644
index 00000000..05592a41
--- /dev/null
+++ b/src/webflow/resources/analyze/resources/reports/types/reports_top_events_request_device_type.py
@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ReportsTopEventsRequestDeviceType = typing.Union[typing.Literal["desktop", "mobile", "tablet"], typing.Any]
diff --git a/src/webflow/resources/analyze/resources/reports/types/reports_top_pages_request_device_type.py b/src/webflow/resources/analyze/resources/reports/types/reports_top_pages_request_device_type.py
new file mode 100644
index 00000000..e9a70a5f
--- /dev/null
+++ b/src/webflow/resources/analyze/resources/reports/types/reports_top_pages_request_device_type.py
@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ReportsTopPagesRequestDeviceType = typing.Union[typing.Literal["desktop", "mobile", "tablet"], typing.Any]
diff --git a/src/webflow/resources/analyze/resources/reports/types/reports_traffic_request_device_type.py b/src/webflow/resources/analyze/resources/reports/types/reports_traffic_request_device_type.py
new file mode 100644
index 00000000..0b1fd972
--- /dev/null
+++ b/src/webflow/resources/analyze/resources/reports/types/reports_traffic_request_device_type.py
@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ReportsTrafficRequestDeviceType = typing.Union[typing.Literal["desktop", "mobile", "tablet"], typing.Any]
diff --git a/src/webflow/resources/assets/client.py b/src/webflow/resources/assets/client.py
index ae22ab4a..9f533e40 100644
--- a/src/webflow/resources/assets/client.py
+++ b/src/webflow/resources/assets/client.py
@@ -34,8 +34,10 @@ def list(
self,
site_id: str,
*,
+ locale_id: typing.Optional[str] = None,
offset: typing.Optional[int] = None,
limit: typing.Optional[int] = None,
+ folder_id: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> Assets:
"""
@@ -48,12 +50,21 @@ def list(
site_id : str
Unique identifier for a Site
+ locale_id : typing.Optional[str]
+ Unique identifier for a specific Locale.
+
+ [Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
offset : typing.Optional[int]
Offset used for pagination if the results have more than limit records
limit : typing.Optional[int]
Maximum number of records to be returned (max limit: 100)
+ folder_id : typing.Optional[str]
+ Filter assets to those in the specified folder and all descendant folders.
+ Must be a 24-character hex ObjectId.
+
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -71,11 +82,20 @@ def list(
)
client.assets.list(
site_id="580e63e98c9a982ac9b8b741",
+ locale_id="65427cf400e02b306eaa04a0",
offset=1,
limit=1,
+ folder_id="folderId",
)
"""
- _response = self._raw_client.list(site_id, offset=offset, limit=limit, request_options=request_options)
+ _response = self._raw_client.list(
+ site_id,
+ locale_id=locale_id,
+ offset=offset,
+ limit=limit,
+ folder_id=folder_id,
+ request_options=request_options,
+ )
return _response.data
def create(
@@ -145,7 +165,13 @@ def create(
)
return _response.data
- def get(self, asset_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Asset:
+ def get(
+ self,
+ asset_id: str,
+ *,
+ locale_id: typing.Optional[str] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> Asset:
"""
Get details about an asset
@@ -156,6 +182,11 @@ def get(self, asset_id: str, *, request_options: typing.Optional[RequestOptions]
asset_id : str
Unique identifier for an Asset on a site
+ locale_id : typing.Optional[str]
+ Unique identifier for a specific Locale.
+
+ [Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -173,9 +204,10 @@ def get(self, asset_id: str, *, request_options: typing.Optional[RequestOptions]
)
client.assets.get(
asset_id="580e63fc8c9a982ac9b8b745",
+ locale_id="65427cf400e02b306eaa04a0",
)
"""
- _response = self._raw_client.get(asset_id, request_options=request_options)
+ _response = self._raw_client.get(asset_id, locale_id=locale_id, request_options=request_options)
return _response.data
def delete(self, asset_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
@@ -214,8 +246,9 @@ def update(
self,
asset_id: str,
*,
- locale_id: typing.Optional[str] = OMIT,
+ locale_id: typing.Optional[str] = None,
display_name: typing.Optional[str] = OMIT,
+ alt_text: typing.Optional[str] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> Asset:
"""
@@ -229,10 +262,15 @@ def update(
Unique identifier for an Asset on a site
locale_id : typing.Optional[str]
- Unique identifier for a specific locale. Applicable, when using localization.
+ Unique identifier for a specific Locale.
+
+ [Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
display_name : typing.Optional[str]
- A human readable name for the asset
+ A human readable name for the asset. This value is not localizable.
+
+ alt_text : typing.Optional[str]
+ Alternate text describing the image
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -251,10 +289,11 @@ def update(
)
client.assets.update(
asset_id="580e63fc8c9a982ac9b8b745",
+ locale_id="65427cf400e02b306eaa04a0",
)
"""
_response = self._raw_client.update(
- asset_id, locale_id=locale_id, display_name=display_name, request_options=request_options
+ asset_id, locale_id=locale_id, display_name=display_name, alt_text=alt_text, request_options=request_options
)
return _response.data
@@ -395,8 +434,10 @@ async def list(
self,
site_id: str,
*,
+ locale_id: typing.Optional[str] = None,
offset: typing.Optional[int] = None,
limit: typing.Optional[int] = None,
+ folder_id: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> Assets:
"""
@@ -409,12 +450,21 @@ async def list(
site_id : str
Unique identifier for a Site
+ locale_id : typing.Optional[str]
+ Unique identifier for a specific Locale.
+
+ [Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
offset : typing.Optional[int]
Offset used for pagination if the results have more than limit records
limit : typing.Optional[int]
Maximum number of records to be returned (max limit: 100)
+ folder_id : typing.Optional[str]
+ Filter assets to those in the specified folder and all descendant folders.
+ Must be a 24-character hex ObjectId.
+
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -437,14 +487,23 @@ async def list(
async def main() -> None:
await client.assets.list(
site_id="580e63e98c9a982ac9b8b741",
+ locale_id="65427cf400e02b306eaa04a0",
offset=1,
limit=1,
+ folder_id="folderId",
)
asyncio.run(main())
"""
- _response = await self._raw_client.list(site_id, offset=offset, limit=limit, request_options=request_options)
+ _response = await self._raw_client.list(
+ site_id,
+ locale_id=locale_id,
+ offset=offset,
+ limit=limit,
+ folder_id=folder_id,
+ request_options=request_options,
+ )
return _response.data
async def create(
@@ -522,7 +581,13 @@ async def main() -> None:
)
return _response.data
- async def get(self, asset_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Asset:
+ async def get(
+ self,
+ asset_id: str,
+ *,
+ locale_id: typing.Optional[str] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> Asset:
"""
Get details about an asset
@@ -533,6 +598,11 @@ async def get(self, asset_id: str, *, request_options: typing.Optional[RequestOp
asset_id : str
Unique identifier for an Asset on a site
+ locale_id : typing.Optional[str]
+ Unique identifier for a specific Locale.
+
+ [Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -555,12 +625,13 @@ async def get(self, asset_id: str, *, request_options: typing.Optional[RequestOp
async def main() -> None:
await client.assets.get(
asset_id="580e63fc8c9a982ac9b8b745",
+ locale_id="65427cf400e02b306eaa04a0",
)
asyncio.run(main())
"""
- _response = await self._raw_client.get(asset_id, request_options=request_options)
+ _response = await self._raw_client.get(asset_id, locale_id=locale_id, request_options=request_options)
return _response.data
async def delete(self, asset_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
@@ -607,8 +678,9 @@ async def update(
self,
asset_id: str,
*,
- locale_id: typing.Optional[str] = OMIT,
+ locale_id: typing.Optional[str] = None,
display_name: typing.Optional[str] = OMIT,
+ alt_text: typing.Optional[str] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> Asset:
"""
@@ -622,10 +694,15 @@ async def update(
Unique identifier for an Asset on a site
locale_id : typing.Optional[str]
- Unique identifier for a specific locale. Applicable, when using localization.
+ Unique identifier for a specific Locale.
+
+ [Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
display_name : typing.Optional[str]
- A human readable name for the asset
+ A human readable name for the asset. This value is not localizable.
+
+ alt_text : typing.Optional[str]
+ Alternate text describing the image
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -649,13 +726,14 @@ async def update(
async def main() -> None:
await client.assets.update(
asset_id="580e63fc8c9a982ac9b8b745",
+ locale_id="65427cf400e02b306eaa04a0",
)
asyncio.run(main())
"""
_response = await self._raw_client.update(
- asset_id, locale_id=locale_id, display_name=display_name, request_options=request_options
+ asset_id, locale_id=locale_id, display_name=display_name, alt_text=alt_text, request_options=request_options
)
return _response.data
diff --git a/src/webflow/resources/assets/raw_client.py b/src/webflow/resources/assets/raw_client.py
index 5c99d982..bb22d652 100644
--- a/src/webflow/resources/assets/raw_client.py
+++ b/src/webflow/resources/assets/raw_client.py
@@ -35,8 +35,10 @@ def list(
self,
site_id: str,
*,
+ locale_id: typing.Optional[str] = None,
offset: typing.Optional[int] = None,
limit: typing.Optional[int] = None,
+ folder_id: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[Assets]:
"""
@@ -49,12 +51,21 @@ def list(
site_id : str
Unique identifier for a Site
+ locale_id : typing.Optional[str]
+ Unique identifier for a specific Locale.
+
+ [Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
offset : typing.Optional[int]
Offset used for pagination if the results have more than limit records
limit : typing.Optional[int]
Maximum number of records to be returned (max limit: 100)
+ folder_id : typing.Optional[str]
+ Filter assets to those in the specified folder and all descendant folders.
+ Must be a 24-character hex ObjectId.
+
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -68,8 +79,10 @@ def list(
base_url=self._client_wrapper.get_environment().base,
method="GET",
params={
+ "localeId": locale_id,
"offset": offset,
"limit": limit,
+ "folderId": folder_id,
},
request_options=request_options,
)
@@ -281,7 +294,13 @@ def create(
)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
- def get(self, asset_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Asset]:
+ def get(
+ self,
+ asset_id: str,
+ *,
+ locale_id: typing.Optional[str] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> HttpResponse[Asset]:
"""
Get details about an asset
@@ -292,6 +311,11 @@ def get(self, asset_id: str, *, request_options: typing.Optional[RequestOptions]
asset_id : str
Unique identifier for an Asset on a site
+ locale_id : typing.Optional[str]
+ Unique identifier for a specific Locale.
+
+ [Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -304,6 +328,9 @@ def get(self, asset_id: str, *, request_options: typing.Optional[RequestOptions]
f"assets/{jsonable_encoder(asset_id)}",
base_url=self._client_wrapper.get_environment().base,
method="GET",
+ params={
+ "localeId": locale_id,
+ },
request_options=request_options,
)
try:
@@ -475,8 +502,9 @@ def update(
self,
asset_id: str,
*,
- locale_id: typing.Optional[str] = OMIT,
+ locale_id: typing.Optional[str] = None,
display_name: typing.Optional[str] = OMIT,
+ alt_text: typing.Optional[str] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[Asset]:
"""
@@ -490,10 +518,15 @@ def update(
Unique identifier for an Asset on a site
locale_id : typing.Optional[str]
- Unique identifier for a specific locale. Applicable, when using localization.
+ Unique identifier for a specific Locale.
+
+ [Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
display_name : typing.Optional[str]
- A human readable name for the asset
+ A human readable name for the asset. This value is not localizable.
+
+ alt_text : typing.Optional[str]
+ Alternate text describing the image
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -507,9 +540,12 @@ def update(
f"assets/{jsonable_encoder(asset_id)}",
base_url=self._client_wrapper.get_environment().base,
method="PATCH",
- json={
+ params={
"localeId": locale_id,
+ },
+ json={
"displayName": display_name,
+ "altText": alt_text,
},
headers={
"content-type": "application/json",
@@ -922,8 +958,10 @@ async def list(
self,
site_id: str,
*,
+ locale_id: typing.Optional[str] = None,
offset: typing.Optional[int] = None,
limit: typing.Optional[int] = None,
+ folder_id: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[Assets]:
"""
@@ -936,12 +974,21 @@ async def list(
site_id : str
Unique identifier for a Site
+ locale_id : typing.Optional[str]
+ Unique identifier for a specific Locale.
+
+ [Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
offset : typing.Optional[int]
Offset used for pagination if the results have more than limit records
limit : typing.Optional[int]
Maximum number of records to be returned (max limit: 100)
+ folder_id : typing.Optional[str]
+ Filter assets to those in the specified folder and all descendant folders.
+ Must be a 24-character hex ObjectId.
+
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -955,8 +1002,10 @@ async def list(
base_url=self._client_wrapper.get_environment().base,
method="GET",
params={
+ "localeId": locale_id,
"offset": offset,
"limit": limit,
+ "folderId": folder_id,
},
request_options=request_options,
)
@@ -1169,7 +1218,11 @@ async def create(
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
async def get(
- self, asset_id: str, *, request_options: typing.Optional[RequestOptions] = None
+ self,
+ asset_id: str,
+ *,
+ locale_id: typing.Optional[str] = None,
+ request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[Asset]:
"""
Get details about an asset
@@ -1181,6 +1234,11 @@ async def get(
asset_id : str
Unique identifier for an Asset on a site
+ locale_id : typing.Optional[str]
+ Unique identifier for a specific Locale.
+
+ [Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -1193,6 +1251,9 @@ async def get(
f"assets/{jsonable_encoder(asset_id)}",
base_url=self._client_wrapper.get_environment().base,
method="GET",
+ params={
+ "localeId": locale_id,
+ },
request_options=request_options,
)
try:
@@ -1366,8 +1427,9 @@ async def update(
self,
asset_id: str,
*,
- locale_id: typing.Optional[str] = OMIT,
+ locale_id: typing.Optional[str] = None,
display_name: typing.Optional[str] = OMIT,
+ alt_text: typing.Optional[str] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[Asset]:
"""
@@ -1381,10 +1443,15 @@ async def update(
Unique identifier for an Asset on a site
locale_id : typing.Optional[str]
- Unique identifier for a specific locale. Applicable, when using localization.
+ Unique identifier for a specific Locale.
+
+ [Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
display_name : typing.Optional[str]
- A human readable name for the asset
+ A human readable name for the asset. This value is not localizable.
+
+ alt_text : typing.Optional[str]
+ Alternate text describing the image
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -1398,9 +1465,12 @@ async def update(
f"assets/{jsonable_encoder(asset_id)}",
base_url=self._client_wrapper.get_environment().base,
method="PATCH",
- json={
+ params={
"localeId": locale_id,
+ },
+ json={
"displayName": display_name,
+ "altText": alt_text,
},
headers={
"content-type": "application/json",
diff --git a/src/webflow/resources/collections/__init__.py b/src/webflow/resources/collections/__init__.py
index 07eb5d1e..6dc2a5c1 100644
--- a/src/webflow/resources/collections/__init__.py
+++ b/src/webflow/resources/collections/__init__.py
@@ -15,10 +15,21 @@
ItemsCreateItemRequestBody,
ItemsDeleteItemsLiveRequestItemsItem,
ItemsDeleteItemsRequestItemsItem,
+ ItemsInsertItemsResponse,
+ ItemsListItemsLiveRequestFilterValue,
+ ItemsListItemsLiveRequestFilterValueExists,
+ ItemsListItemsLiveRequestFilterValueIn,
+ ItemsListItemsLiveRequestFilterValueNin,
ItemsListItemsLiveRequestSortBy,
ItemsListItemsLiveRequestSortOrder,
+ ItemsListItemsLiveRequestSortValue,
+ ItemsListItemsRequestFilterValue,
+ ItemsListItemsRequestFilterValueExists,
+ ItemsListItemsRequestFilterValueIn,
+ ItemsListItemsRequestFilterValueNin,
ItemsListItemsRequestSortBy,
ItemsListItemsRequestSortOrder,
+ ItemsListItemsRequestSortValue,
ItemsPublishItemRequest,
ItemsPublishItemRequestItemsItemsItem,
ItemsPublishItemResponse,
@@ -38,10 +49,21 @@
"ItemsCreateItemRequestBody": ".resources",
"ItemsDeleteItemsLiveRequestItemsItem": ".resources",
"ItemsDeleteItemsRequestItemsItem": ".resources",
+ "ItemsInsertItemsResponse": ".resources",
+ "ItemsListItemsLiveRequestFilterValue": ".resources",
+ "ItemsListItemsLiveRequestFilterValueExists": ".resources",
+ "ItemsListItemsLiveRequestFilterValueIn": ".resources",
+ "ItemsListItemsLiveRequestFilterValueNin": ".resources",
"ItemsListItemsLiveRequestSortBy": ".resources",
"ItemsListItemsLiveRequestSortOrder": ".resources",
+ "ItemsListItemsLiveRequestSortValue": ".resources",
+ "ItemsListItemsRequestFilterValue": ".resources",
+ "ItemsListItemsRequestFilterValueExists": ".resources",
+ "ItemsListItemsRequestFilterValueIn": ".resources",
+ "ItemsListItemsRequestFilterValueNin": ".resources",
"ItemsListItemsRequestSortBy": ".resources",
"ItemsListItemsRequestSortOrder": ".resources",
+ "ItemsListItemsRequestSortValue": ".resources",
"ItemsPublishItemRequest": ".resources",
"ItemsPublishItemRequestItemsItemsItem": ".resources",
"ItemsPublishItemResponse": ".resources",
@@ -84,10 +106,21 @@ def __dir__():
"ItemsCreateItemRequestBody",
"ItemsDeleteItemsLiveRequestItemsItem",
"ItemsDeleteItemsRequestItemsItem",
+ "ItemsInsertItemsResponse",
+ "ItemsListItemsLiveRequestFilterValue",
+ "ItemsListItemsLiveRequestFilterValueExists",
+ "ItemsListItemsLiveRequestFilterValueIn",
+ "ItemsListItemsLiveRequestFilterValueNin",
"ItemsListItemsLiveRequestSortBy",
"ItemsListItemsLiveRequestSortOrder",
+ "ItemsListItemsLiveRequestSortValue",
+ "ItemsListItemsRequestFilterValue",
+ "ItemsListItemsRequestFilterValueExists",
+ "ItemsListItemsRequestFilterValueIn",
+ "ItemsListItemsRequestFilterValueNin",
"ItemsListItemsRequestSortBy",
"ItemsListItemsRequestSortOrder",
+ "ItemsListItemsRequestSortValue",
"ItemsPublishItemRequest",
"ItemsPublishItemRequestItemsItemsItem",
"ItemsPublishItemResponse",
diff --git a/src/webflow/resources/collections/client.py b/src/webflow/resources/collections/client.py
index bd4adca2..288f16d7 100644
--- a/src/webflow/resources/collections/client.py
+++ b/src/webflow/resources/collections/client.py
@@ -9,6 +9,7 @@
from ...types.collection import Collection
from ...types.collection_list import CollectionList
from ...types.field_create import FieldCreate
+from ...types.field_group import FieldGroup
from .raw_client import AsyncRawCollectionsClient, RawCollectionsClient
if typing.TYPE_CHECKING:
@@ -223,6 +224,73 @@ def delete(self, collection_id: str, *, request_options: typing.Optional[Request
_response = self._raw_client.delete(collection_id, request_options=request_options)
return _response.data
+ def patch(
+ self,
+ collection_id: str,
+ *,
+ display_name: typing.Optional[str] = OMIT,
+ singular_name: typing.Optional[str] = OMIT,
+ slug: typing.Optional[str] = OMIT,
+ field_groups: typing.Optional[typing.Sequence[FieldGroup]] = OMIT,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> Collection:
+ """
+ Update a collection's display name, singular name, slug, or field groups.
+
+ **Field group rules:**
+ - A collection can have a maximum of 50 field groups
+ - Each `displayName` must be unique across all field groups in the collection
+ - Each `fieldId` must be unique across all field groups in the collection
+ - Ecommerce collections do not support field groups
+
+ Required scope | `cms:write`
+
+ Parameters
+ ----------
+ collection_id : str
+ Unique identifier for a Collection
+
+ display_name : typing.Optional[str]
+ Name given to the Collection
+
+ singular_name : typing.Optional[str]
+ The name of one Item in Collection (e.g. ”Blog Post” if the Collection is called “Blog Posts”)
+
+ slug : typing.Optional[str]
+ Slug of Collection in Site URL structure
+
+ field_groups : typing.Optional[typing.Sequence[FieldGroup]]
+ The list of field groups in the Collection. Replaces the existing field groups.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ Collection
+ Request was successful
+
+ Examples
+ --------
+ from webflow import Webflow
+
+ client = Webflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+ client.collections.patch(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ )
+ """
+ _response = self._raw_client.patch(
+ collection_id,
+ display_name=display_name,
+ singular_name=singular_name,
+ slug=slug,
+ field_groups=field_groups,
+ request_options=request_options,
+ )
+ return _response.data
+
@property
def fields(self):
if self._fields is None:
@@ -482,6 +550,81 @@ async def main() -> None:
_response = await self._raw_client.delete(collection_id, request_options=request_options)
return _response.data
+ async def patch(
+ self,
+ collection_id: str,
+ *,
+ display_name: typing.Optional[str] = OMIT,
+ singular_name: typing.Optional[str] = OMIT,
+ slug: typing.Optional[str] = OMIT,
+ field_groups: typing.Optional[typing.Sequence[FieldGroup]] = OMIT,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> Collection:
+ """
+ Update a collection's display name, singular name, slug, or field groups.
+
+ **Field group rules:**
+ - A collection can have a maximum of 50 field groups
+ - Each `displayName` must be unique across all field groups in the collection
+ - Each `fieldId` must be unique across all field groups in the collection
+ - Ecommerce collections do not support field groups
+
+ Required scope | `cms:write`
+
+ Parameters
+ ----------
+ collection_id : str
+ Unique identifier for a Collection
+
+ display_name : typing.Optional[str]
+ Name given to the Collection
+
+ singular_name : typing.Optional[str]
+ The name of one Item in Collection (e.g. ”Blog Post” if the Collection is called “Blog Posts”)
+
+ slug : typing.Optional[str]
+ Slug of Collection in Site URL structure
+
+ field_groups : typing.Optional[typing.Sequence[FieldGroup]]
+ The list of field groups in the Collection. Replaces the existing field groups.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ Collection
+ Request was successful
+
+ Examples
+ --------
+ import asyncio
+
+ from webflow import AsyncWebflow
+
+ client = AsyncWebflow(
+ access_token="YOUR_ACCESS_TOKEN",
+ )
+
+
+ async def main() -> None:
+ await client.collections.patch(
+ collection_id="580e63fc8c9a982ac9b8b745",
+ )
+
+
+ asyncio.run(main())
+ """
+ _response = await self._raw_client.patch(
+ collection_id,
+ display_name=display_name,
+ singular_name=singular_name,
+ slug=slug,
+ field_groups=field_groups,
+ request_options=request_options,
+ )
+ return _response.data
+
@property
def fields(self):
if self._fields is None:
diff --git a/src/webflow/resources/collections/raw_client.py b/src/webflow/resources/collections/raw_client.py
index ffc84511..019ecdeb 100644
--- a/src/webflow/resources/collections/raw_client.py
+++ b/src/webflow/resources/collections/raw_client.py
@@ -21,6 +21,7 @@
from ...types.collection_list import CollectionList
from ...types.error import Error
from ...types.field_create import FieldCreate
+from ...types.field_group import FieldGroup
from pydantic import ValidationError
# this is used as the default value for optional parameters
@@ -471,6 +472,144 @@ def delete(
)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+ def patch(
+ self,
+ collection_id: str,
+ *,
+ display_name: typing.Optional[str] = OMIT,
+ singular_name: typing.Optional[str] = OMIT,
+ slug: typing.Optional[str] = OMIT,
+ field_groups: typing.Optional[typing.Sequence[FieldGroup]] = OMIT,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> HttpResponse[Collection]:
+ """
+ Update a collection's display name, singular name, slug, or field groups.
+
+ **Field group rules:**
+ - A collection can have a maximum of 50 field groups
+ - Each `displayName` must be unique across all field groups in the collection
+ - Each `fieldId` must be unique across all field groups in the collection
+ - Ecommerce collections do not support field groups
+
+ Required scope | `cms:write`
+
+ Parameters
+ ----------
+ collection_id : str
+ Unique identifier for a Collection
+
+ display_name : typing.Optional[str]
+ Name given to the Collection
+
+ singular_name : typing.Optional[str]
+ The name of one Item in Collection (e.g. ”Blog Post” if the Collection is called “Blog Posts”)
+
+ slug : typing.Optional[str]
+ Slug of Collection in Site URL structure
+
+ field_groups : typing.Optional[typing.Sequence[FieldGroup]]
+ The list of field groups in the Collection. Replaces the existing field groups.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ HttpResponse[Collection]
+ Request was successful
+ """
+ _response = self._client_wrapper.httpx_client.request(
+ f"collections/{jsonable_encoder(collection_id)}",
+ base_url=self._client_wrapper.get_environment().base,
+ method="PATCH",
+ json={
+ "displayName": display_name,
+ "singularName": singular_name,
+ "slug": slug,
+ "fieldGroups": convert_and_respect_annotation_metadata(
+ object_=field_groups, annotation=typing.Sequence[FieldGroup], direction="write"
+ ),
+ },
+ headers={
+ "content-type": "application/json",
+ },
+ request_options=request_options,
+ omit=OMIT,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ Collection,
+ parse_obj_as(
+ type_=Collection, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return HttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
class AsyncRawCollectionsClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -915,3 +1054,141 @@ async def delete(
status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+ async def patch(
+ self,
+ collection_id: str,
+ *,
+ display_name: typing.Optional[str] = OMIT,
+ singular_name: typing.Optional[str] = OMIT,
+ slug: typing.Optional[str] = OMIT,
+ field_groups: typing.Optional[typing.Sequence[FieldGroup]] = OMIT,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> AsyncHttpResponse[Collection]:
+ """
+ Update a collection's display name, singular name, slug, or field groups.
+
+ **Field group rules:**
+ - A collection can have a maximum of 50 field groups
+ - Each `displayName` must be unique across all field groups in the collection
+ - Each `fieldId` must be unique across all field groups in the collection
+ - Ecommerce collections do not support field groups
+
+ Required scope | `cms:write`
+
+ Parameters
+ ----------
+ collection_id : str
+ Unique identifier for a Collection
+
+ display_name : typing.Optional[str]
+ Name given to the Collection
+
+ singular_name : typing.Optional[str]
+ The name of one Item in Collection (e.g. ”Blog Post” if the Collection is called “Blog Posts”)
+
+ slug : typing.Optional[str]
+ Slug of Collection in Site URL structure
+
+ field_groups : typing.Optional[typing.Sequence[FieldGroup]]
+ The list of field groups in the Collection. Replaces the existing field groups.
+
+ request_options : typing.Optional[RequestOptions]
+ Request-specific configuration.
+
+ Returns
+ -------
+ AsyncHttpResponse[Collection]
+ Request was successful
+ """
+ _response = await self._client_wrapper.httpx_client.request(
+ f"collections/{jsonable_encoder(collection_id)}",
+ base_url=self._client_wrapper.get_environment().base,
+ method="PATCH",
+ json={
+ "displayName": display_name,
+ "singularName": singular_name,
+ "slug": slug,
+ "fieldGroups": convert_and_respect_annotation_metadata(
+ object_=field_groups, annotation=typing.Sequence[FieldGroup], direction="write"
+ ),
+ },
+ headers={
+ "content-type": "application/json",
+ },
+ request_options=request_options,
+ omit=OMIT,
+ )
+ try:
+ if 200 <= _response.status_code < 300:
+ _data = typing.cast(
+ Collection,
+ parse_obj_as(
+ type_=Collection, # type: ignore
+ object_=_response.json(),
+ ),
+ )
+ return AsyncHttpResponse(response=_response, data=_data)
+ if _response.status_code == 400:
+ raise BadRequestError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ typing.Any,
+ parse_obj_as(
+ type_=typing.Any, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 401:
+ raise UnauthorizedError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 404:
+ raise NotFoundError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 429:
+ raise TooManyRequestsError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ if _response.status_code == 500:
+ raise InternalServerError(
+ headers=dict(_response.headers),
+ body=typing.cast(
+ Error,
+ parse_obj_as(
+ type_=Error, # type: ignore
+ object_=_response.json(),
+ ),
+ ),
+ )
+ _response_json = _response.json()
+ except JSONDecodeError:
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+ except ValidationError as e:
+ raise ParsingError(
+ status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+ )
+ raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
diff --git a/src/webflow/resources/collections/resources/__init__.py b/src/webflow/resources/collections/resources/__init__.py
index 7123bf3f..ff6a0903 100644
--- a/src/webflow/resources/collections/resources/__init__.py
+++ b/src/webflow/resources/collections/resources/__init__.py
@@ -16,10 +16,21 @@
ItemsCreateItemRequestBody,
ItemsDeleteItemsLiveRequestItemsItem,
ItemsDeleteItemsRequestItemsItem,
+ ItemsInsertItemsResponse,
+ ItemsListItemsLiveRequestFilterValue,
+ ItemsListItemsLiveRequestFilterValueExists,
+ ItemsListItemsLiveRequestFilterValueIn,
+ ItemsListItemsLiveRequestFilterValueNin,
ItemsListItemsLiveRequestSortBy,
ItemsListItemsLiveRequestSortOrder,
+ ItemsListItemsLiveRequestSortValue,
+ ItemsListItemsRequestFilterValue,
+ ItemsListItemsRequestFilterValueExists,
+ ItemsListItemsRequestFilterValueIn,
+ ItemsListItemsRequestFilterValueNin,
ItemsListItemsRequestSortBy,
ItemsListItemsRequestSortOrder,
+ ItemsListItemsRequestSortValue,
ItemsPublishItemRequest,
ItemsPublishItemRequestItemsItemsItem,
ItemsPublishItemResponse,
@@ -37,10 +48,21 @@
"ItemsCreateItemRequestBody": ".items",
"ItemsDeleteItemsLiveRequestItemsItem": ".items",
"ItemsDeleteItemsRequestItemsItem": ".items",
+ "ItemsInsertItemsResponse": ".items",
+ "ItemsListItemsLiveRequestFilterValue": ".items",
+ "ItemsListItemsLiveRequestFilterValueExists": ".items",
+ "ItemsListItemsLiveRequestFilterValueIn": ".items",
+ "ItemsListItemsLiveRequestFilterValueNin": ".items",
"ItemsListItemsLiveRequestSortBy": ".items",
"ItemsListItemsLiveRequestSortOrder": ".items",
+ "ItemsListItemsLiveRequestSortValue": ".items",
+ "ItemsListItemsRequestFilterValue": ".items",
+ "ItemsListItemsRequestFilterValueExists": ".items",
+ "ItemsListItemsRequestFilterValueIn": ".items",
+ "ItemsListItemsRequestFilterValueNin": ".items",
"ItemsListItemsRequestSortBy": ".items",
"ItemsListItemsRequestSortOrder": ".items",
+ "ItemsListItemsRequestSortValue": ".items",
"ItemsPublishItemRequest": ".items",
"ItemsPublishItemRequestItemsItemsItem": ".items",
"ItemsPublishItemResponse": ".items",
@@ -83,10 +105,21 @@ def __dir__():
"ItemsCreateItemRequestBody",
"ItemsDeleteItemsLiveRequestItemsItem",
"ItemsDeleteItemsRequestItemsItem",
+ "ItemsInsertItemsResponse",
+ "ItemsListItemsLiveRequestFilterValue",
+ "ItemsListItemsLiveRequestFilterValueExists",
+ "ItemsListItemsLiveRequestFilterValueIn",
+ "ItemsListItemsLiveRequestFilterValueNin",
"ItemsListItemsLiveRequestSortBy",
"ItemsListItemsLiveRequestSortOrder",
+ "ItemsListItemsLiveRequestSortValue",
+ "ItemsListItemsRequestFilterValue",
+ "ItemsListItemsRequestFilterValueExists",
+ "ItemsListItemsRequestFilterValueIn",
+ "ItemsListItemsRequestFilterValueNin",
"ItemsListItemsRequestSortBy",
"ItemsListItemsRequestSortOrder",
+ "ItemsListItemsRequestSortValue",
"ItemsPublishItemRequest",
"ItemsPublishItemRequestItemsItemsItem",
"ItemsPublishItemResponse",
diff --git a/src/webflow/resources/collections/resources/fields/raw_client.py b/src/webflow/resources/collections/resources/fields/raw_client.py
index 31f26bef..cc819d1d 100644
--- a/src/webflow/resources/collections/resources/fields/raw_client.py
+++ b/src/webflow/resources/collections/resources/fields/raw_client.py
@@ -62,9 +62,6 @@ def create(
base_url=self._client_wrapper.get_environment().base,
method="POST",
json=convert_and_respect_annotation_metadata(object_=request, annotation=FieldCreate, direction="write"),
- headers={
- "content-type": "application/json",
- },
request_options=request_options,
omit=OMIT,
)
@@ -415,9 +412,6 @@ async def create(
base_url=self._client_wrapper.get_environment().base,
method="POST",
json=convert_and_respect_annotation_metadata(object_=request, annotation=FieldCreate, direction="write"),
- headers={
- "content-type": "application/json",
- },
request_options=request_options,
omit=OMIT,
)
diff --git a/src/webflow/resources/collections/resources/items/__init__.py b/src/webflow/resources/collections/resources/items/__init__.py
index ae894396..e9b2e71a 100644
--- a/src/webflow/resources/collections/resources/items/__init__.py
+++ b/src/webflow/resources/collections/resources/items/__init__.py
@@ -15,10 +15,21 @@
ItemsCreateItemRequestBody,
ItemsDeleteItemsLiveRequestItemsItem,
ItemsDeleteItemsRequestItemsItem,
+ ItemsInsertItemsResponse,
+ ItemsListItemsLiveRequestFilterValue,
+ ItemsListItemsLiveRequestFilterValueExists,
+ ItemsListItemsLiveRequestFilterValueIn,
+ ItemsListItemsLiveRequestFilterValueNin,
ItemsListItemsLiveRequestSortBy,
ItemsListItemsLiveRequestSortOrder,
+ ItemsListItemsLiveRequestSortValue,
+ ItemsListItemsRequestFilterValue,
+ ItemsListItemsRequestFilterValueExists,
+ ItemsListItemsRequestFilterValueIn,
+ ItemsListItemsRequestFilterValueNin,
ItemsListItemsRequestSortBy,
ItemsListItemsRequestSortOrder,
+ ItemsListItemsRequestSortValue,
ItemsPublishItemRequest,
ItemsPublishItemRequestItemsItemsItem,
ItemsPublishItemResponse,
@@ -36,10 +47,21 @@
"ItemsCreateItemRequestBody": ".types",
"ItemsDeleteItemsLiveRequestItemsItem": ".types",
"ItemsDeleteItemsRequestItemsItem": ".types",
+ "ItemsInsertItemsResponse": ".types",
+ "ItemsListItemsLiveRequestFilterValue": ".types",
+ "ItemsListItemsLiveRequestFilterValueExists": ".types",
+ "ItemsListItemsLiveRequestFilterValueIn": ".types",
+ "ItemsListItemsLiveRequestFilterValueNin": ".types",
"ItemsListItemsLiveRequestSortBy": ".types",
"ItemsListItemsLiveRequestSortOrder": ".types",
+ "ItemsListItemsLiveRequestSortValue": ".types",
+ "ItemsListItemsRequestFilterValue": ".types",
+ "ItemsListItemsRequestFilterValueExists": ".types",
+ "ItemsListItemsRequestFilterValueIn": ".types",
+ "ItemsListItemsRequestFilterValueNin": ".types",
"ItemsListItemsRequestSortBy": ".types",
"ItemsListItemsRequestSortOrder": ".types",
+ "ItemsListItemsRequestSortValue": ".types",
"ItemsPublishItemRequest": ".types",
"ItemsPublishItemRequestItemsItemsItem": ".types",
"ItemsPublishItemResponse": ".types",
@@ -80,10 +102,21 @@ def __dir__():
"ItemsCreateItemRequestBody",
"ItemsDeleteItemsLiveRequestItemsItem",
"ItemsDeleteItemsRequestItemsItem",
+ "ItemsInsertItemsResponse",
+ "ItemsListItemsLiveRequestFilterValue",
+ "ItemsListItemsLiveRequestFilterValueExists",
+ "ItemsListItemsLiveRequestFilterValueIn",
+ "ItemsListItemsLiveRequestFilterValueNin",
"ItemsListItemsLiveRequestSortBy",
"ItemsListItemsLiveRequestSortOrder",
+ "ItemsListItemsLiveRequestSortValue",
+ "ItemsListItemsRequestFilterValue",
+ "ItemsListItemsRequestFilterValueExists",
+ "ItemsListItemsRequestFilterValueIn",
+ "ItemsListItemsRequestFilterValueNin",
"ItemsListItemsRequestSortBy",
"ItemsListItemsRequestSortOrder",
+ "ItemsListItemsRequestSortValue",
"ItemsPublishItemRequest",
"ItemsPublishItemRequestItemsItemsItem",
"ItemsPublishItemResponse",
diff --git a/src/webflow/resources/collections/resources/items/client.py b/src/webflow/resources/collections/resources/items/client.py
index 16f1d5c9..7ab96b5b 100644
--- a/src/webflow/resources/collections/resources/items/client.py
+++ b/src/webflow/resources/collections/resources/items/client.py
@@ -10,18 +10,28 @@
from .....types.collection_item_list_no_pagination import CollectionItemListNoPagination
from .....types.collection_item_patch_single_field_data import CollectionItemPatchSingleFieldData
from .....types.collection_item_with_id_input import CollectionItemWithIdInput
+from .....types.insert_collection_item import InsertCollectionItem
+from .....types.items_list_items_live_request_created_on import ItemsListItemsLiveRequestCreatedOn
from .....types.items_list_items_live_request_last_published import ItemsListItemsLiveRequestLastPublished
+from .....types.items_list_items_live_request_last_updated import ItemsListItemsLiveRequestLastUpdated
+from .....types.items_list_items_request_created_on import ItemsListItemsRequestCreatedOn
from .....types.items_list_items_request_last_published import ItemsListItemsRequestLastPublished
+from .....types.items_list_items_request_last_updated import ItemsListItemsRequestLastUpdated
from .raw_client import AsyncRawItemsClient, RawItemsClient
from .types.create_bulk_collection_item_request_body_field_data import CreateBulkCollectionItemRequestBodyFieldData
from .types.items_create_item_live_request_body import ItemsCreateItemLiveRequestBody
from .types.items_create_item_request_body import ItemsCreateItemRequestBody
from .types.items_delete_items_live_request_items_item import ItemsDeleteItemsLiveRequestItemsItem
from .types.items_delete_items_request_items_item import ItemsDeleteItemsRequestItemsItem
+from .types.items_insert_items_response import ItemsInsertItemsResponse
+from .types.items_list_items_live_request_filter_value import ItemsListItemsLiveRequestFilterValue
from .types.items_list_items_live_request_sort_by import ItemsListItemsLiveRequestSortBy
from .types.items_list_items_live_request_sort_order import ItemsListItemsLiveRequestSortOrder
+from .types.items_list_items_live_request_sort_value import ItemsListItemsLiveRequestSortValue
+from .types.items_list_items_request_filter_value import ItemsListItemsRequestFilterValue
from .types.items_list_items_request_sort_by import ItemsListItemsRequestSortBy
from .types.items_list_items_request_sort_order import ItemsListItemsRequestSortOrder
+from .types.items_list_items_request_sort_value import ItemsListItemsRequestSortValue
from .types.items_publish_item_request import ItemsPublishItemRequest
from .types.items_publish_item_response import ItemsPublishItemResponse
from .types.items_update_items_response import ItemsUpdateItemsResponse
@@ -54,14 +64,30 @@ def list_items(
limit: typing.Optional[int] = None,
name: typing.Optional[str] = None,
slug: typing.Optional[str] = None,
+ created_on: typing.Optional[ItemsListItemsRequestCreatedOn] = None,
last_published: typing.Optional[ItemsListItemsRequestLastPublished] = None,
+ last_updated: typing.Optional[ItemsListItemsRequestLastUpdated] = None,
+ filter: typing.Optional[typing.Dict[str, typing.Optional[ItemsListItemsRequestFilterValue]]] = None,
sort_by: typing.Optional[ItemsListItemsRequestSortBy] = None,
sort_order: typing.Optional[ItemsListItemsRequestSortOrder] = None,
+ sort: typing.Optional[typing.Dict[str, typing.Optional[ItemsListItemsRequestSortValue]]] = None,
+ translatable: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> CollectionItemList:
"""
+
+ Rich Text field values can contain Webflow component instances as `` markup — see [Components in Rich Text](/data/docs/working-with-the-cms/components-in-rich-text) for the markup grammar, how to find component and property IDs, and the write constraints.
+
+
List of all Items within a Collection.
+
+ This endpoint supports:
+
+ - Custom `filter[...]` queries support up to 10 filter terms and 2 text-search terms per request.
+ - Custom `sort[...]` queries support up to 3 sort fields per request.
+
+
Required scope | `CMS:read`
Parameters
@@ -84,15 +110,84 @@ def list_items(
slug : typing.Optional[str]
Filter by the exact slug of the item
+ created_on : typing.Optional[ItemsListItemsRequestCreatedOn]
+ Filter by the creation date of the item(s)
+
last_published : typing.Optional[ItemsListItemsRequestLastPublished]
Filter by the last published date of the item(s)
+ last_updated : typing.Optional[ItemsListItemsRequestLastUpdated]
+ Filter by the last updated date of the item(s)
+
+ filter : typing.Optional[typing.Dict[str, typing.Optional[ItemsListItemsRequestFilterValue]]]
+ Filter collection items by custom field values. Use bracket notation:
+ `filter[][]=`.
+
+ Example: `filter[price][gte]=10&filter[price][lte]=100&filter[name][contains]=shirt`.
+
+ Filters are combined with AND. You can combine custom field filters with top-level filters such as `name`, `slug`, `createdOn`, `lastPublished`, and `lastUpdated`. OR logic and nested filter groups are not supported on GET requests.
+
+ More filter terms can increase request latency.
+
+ Supported operators by field type:
+
+ | Field type | Supported operators |
+ | --- | --- |
+ | `id` | `eq`, `ne`, `in`, `nin` |
+ | `PlainText` | `eq`, `ne`, `in`, `nin`, `contains`, `ncontains`, `exists` |
+ | `Number` | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`, `exists` |
+ | `Switch` | `eq`, `ne`, `in`, `nin`, `exists` |
+ | `DateTime` | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`, `exists` |
+ | `Email`, `Phone`, `Link` | `eq`, `ne`, `in`, `nin`, `contains`, `ncontains`, `exists` |
+ | `Color` | `eq`, `ne`, `in`, `nin`, `exists` |
+ | `Reference` | `eq`, `ne`, `in`, `nin`, `exists` |
+ | `Option` | `eq`, `ne`, `in`, `nin` |
+ | `RichText`, `Image`, `MultiImage`, `VideoLink`, `MultiReference` | `exists` |
+
+ `contains` and `ncontains` are case-insensitive. `ncontains` also matches items where the field is empty or not set.
+
+ `exists=true` matches items where the field has a value. `exists=false` matches items where the field is missing or null. For `Switch` fields, `false` is still a set value.
+
+ Value formats:
+
+ | Field type | Value format |
+ | --- | --- |
+ | `Number` | A valid number, such as `10` or `12.5` |
+ | `Switch` | `true` or `false` |
+ | `DateTime` | ISO 8601 date-time string |
+ | `id`, `Reference` | 24-character item ID |
+ | `Option` | Option ID |
+ | `in`, `nin` | Comma-separated list, up to 100 values |
+
+ Invalid fields, invalid values, and operators that do not apply to a field type return a `400 BadArgument` response.
+
sort_by : typing.Optional[ItemsListItemsRequestSortBy]
Sort results by the provided value
sort_order : typing.Optional[ItemsListItemsRequestSortOrder]
Sorts the results by asc or desc
+ sort : typing.Optional[typing.Dict[str, typing.Optional[ItemsListItemsRequestSortValue]]]
+ Sort collection items by custom fields using bracket notation: `sort[]=`.
+
+ - Example: `sort[price]=desc`
+ - Multiple sort fields are applied in query-string order. When `sort[...]` is provided, it takes precedence over `sortBy` and `sortOrder`.
+ - Sortable field types: `PlainText`, `Email`, `Phone`, `Number`, `DateTime`, and `Switch`.
+ - Unknown fields, invalid sort directions, and non-sortable field types return a `400 BadArgument` response.
+
+ translatable : typing.Optional[str]
+ Unique identifier for the secondary Locale you're translating **into**. Returns only content that hasn't been excluded from translation for that locale.
+
+ This is independent of `localeId`, which selects which version of the content is returned. To fetch the source text to translate, request the primary locale's content and set `translatable` to the locale you're translating into:
+
+ `?localeId={primary locale id}&translatable={target locale id}`
+
+ Only exclusion rules scoped to manual translation are respected — rules scoped only to automatic translation don't affect this parameter's response.
+
+ Omitting `translatable` returns the same response as if this parameter didn't exist. The value must be the id of one of the site's secondary locales — the primary locale id, or any other value, returns a `400` error. Requires translation exclusions to be enabled for the site; if they aren't, the request returns a `403` error.
+
+ [Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -115,8 +210,9 @@ def list_items(
limit=1,
name="name",
slug="slug",
- sort_by="lastPublished",
+ sort_by="createdOn",
sort_order="asc",
+ translatable="65427cf400e02b306eaa04a0",
)
"""
_response = self._raw_client.list_items(
@@ -126,9 +222,14 @@ def list_items(
limit=limit,
name=name,
slug=slug,
+ created_on=created_on,
last_published=last_published,
+ last_updated=last_updated,
+ filter=filter,
sort_by=sort_by,
sort_order=sort_order,
+ sort=sort,
+ translatable=translatable,
request_options=request_options,
)
return _response.data
@@ -142,10 +243,47 @@ def create_item(
request_options: typing.Optional[RequestOptions] = None,
) -> CollectionItem:
"""
+
+ Rich Text field values can contain Webflow component instances as `` markup — see [Components in Rich Text](/data/docs/working-with-the-cms/components-in-rich-text) for the markup grammar, how to find component and property IDs, and the write constraints.
+
+
Create Item(s) in a Collection.
+
+ This endpoint remains supported. New integrations should use [Create Items](/data/reference/cms/collection-items/staged-items/create-items), which accepts both request shapes below and can create an item in several locales under one ID. [This guide to creating items](/data/docs/working-with-the-cms/create-items) shows how each shape maps.
+
- To create items across multiple locales, please use [this endpoint.](/data/reference/cms/collection-items/staged-items/create-items)
+ This endpoint accepts two request shapes, and a request must use one or the other:
+
+ - **Single item** — send `fieldData` at the top level. Set `cmsLocaleId` to create the item in a specific locale.
+ - **Multiple items** — send an `items` array with at least one entry. Each entry needs its own `fieldData`, and can set its own `cmsLocaleId`, `isDraft`, and `isArchived`. The API ignores any other property on an entry.
+
+ ```json
+ {
+ "items": [
+ {
+ "isArchived": false,
+ "isDraft": false,
+ "fieldData": {
+ "name": "Senior Data Analyst",
+ "slug": "senior-data-analyst"
+ }
+ },
+ {
+ "isArchived": false,
+ "isDraft": false,
+ "fieldData": {
+ "name": "Product Manager",
+ "slug": "product-manager"
+ }
+ }
+ ]
+ }
+ ```
+
+ A request that carries both `fieldData` and `items` returns a `400`.
+
+ To create an item in several locales under one ID, use [Create Items](/data/reference/cms/collection-items/staged-items/create-items).
Required scope | `CMS:write`
@@ -255,12 +393,25 @@ def update_items(
request_options: typing.Optional[RequestOptions] = None,
) -> ItemsUpdateItemsResponse:
"""
+
+ Rich Text field values can contain Webflow component instances as `` markup — see [Components in Rich Text](/data/docs/working-with-the-cms/components-in-rich-text) for the markup grammar, how to find component and property IDs, and the write constraints.
+
+
Update a single item or multiple items in a Collection.
The limit for this endpoint is 100 items.
Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request.
+
+ `isDraft: true` doesn't unpublish an item. The resulting status depends on whether the item has been published before:
+
+ - **Item that has never been published:** the item gets a `Draft` status.
+ - **Already-published item:** the item gets a `Changes in draft` status. The live item stays published, and your changes are held back until you publish them.
+
+ Setting `isDraft: false` queues the item to publish on the next site publish. To remove an item from the live site, use [Unpublish Live Collection Items](/data/reference/cms/collection-items/live-items/delete-items-live). For the full status mapping, see [Publishing with the CMS API](/data/docs/working-with-the-cms/publishing).
+
+
Required scope | `CMS:write`
Parameters
@@ -345,18 +496,34 @@ def list_items_live(
limit: typing.Optional[int] = None,
name: typing.Optional[str] = None,
slug: typing.Optional[str] = None,
+ created_on: typing.Optional[ItemsListItemsLiveRequestCreatedOn] = None,
last_published: typing.Optional[ItemsListItemsLiveRequestLastPublished] = None,
+ last_updated: typing.Optional[ItemsListItemsLiveRequestLastUpdated] = None,
+ filter: typing.Optional[typing.Dict[str, typing.Optional[ItemsListItemsLiveRequestFilterValue]]] = None,
sort_by: typing.Optional[ItemsListItemsLiveRequestSortBy] = None,
sort_order: typing.Optional[ItemsListItemsLiveRequestSortOrder] = None,
+ sort: typing.Optional[typing.Dict[str, typing.Optional[ItemsListItemsLiveRequestSortValue]]] = None,
+ translatable: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> CollectionItemList:
"""
+
+ Rich Text field values can contain Webflow component instances as `` markup — see [Components in Rich Text](/data/docs/working-with-the-cms/components-in-rich-text) for the markup grammar, how to find component and property IDs, and the write constraints.
+
+
List all published items in a collection.
Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations.
+
+ This endpoint supports:
+
+ - Custom `filter[...]` queries support up to 10 filter terms and 2 text-search terms per request.
+ - Custom `sort[...]` queries support up to 3 sort fields per request.
+
+
Required scope | `CMS:read`
Parameters
@@ -379,15 +546,84 @@ def list_items_live(
slug : typing.Optional[str]
Filter by the exact slug of the item
+ created_on : typing.Optional[ItemsListItemsLiveRequestCreatedOn]
+ Filter by the creation date of the item(s)
+
last_published : typing.Optional[ItemsListItemsLiveRequestLastPublished]
Filter by the last published date of the item(s)
+ last_updated : typing.Optional[ItemsListItemsLiveRequestLastUpdated]
+ Filter by the last updated date of the item(s)
+
+ filter : typing.Optional[typing.Dict[str, typing.Optional[ItemsListItemsLiveRequestFilterValue]]]
+ Filter collection items by custom field values. Use bracket notation:
+ `filter[][]=`.
+
+ Example: `filter[price][gte]=10&filter[price][lte]=100&filter[name][contains]=shirt`.
+
+ Filters are combined with AND. You can combine custom field filters with top-level filters such as `name`, `slug`, `createdOn`, `lastPublished`, and `lastUpdated`. OR logic and nested filter groups are not supported on GET requests.
+
+ More filter terms can increase request latency.
+
+ Supported operators by field type:
+
+ | Field type | Supported operators |
+ | --- | --- |
+ | `id` | `eq`, `ne`, `in`, `nin` |
+ | `PlainText` | `eq`, `ne`, `in`, `nin`, `contains`, `ncontains`, `exists` |
+ | `Number` | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`, `exists` |
+ | `Switch` | `eq`, `ne`, `in`, `nin`, `exists` |
+ | `DateTime` | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`, `exists` |
+ | `Email`, `Phone`, `Link` | `eq`, `ne`, `in`, `nin`, `contains`, `ncontains`, `exists` |
+ | `Color` | `eq`, `ne`, `in`, `nin`, `exists` |
+ | `Reference` | `eq`, `ne`, `in`, `nin`, `exists` |
+ | `Option` | `eq`, `ne`, `in`, `nin` |
+ | `RichText`, `Image`, `MultiImage`, `VideoLink`, `MultiReference` | `exists` |
+
+ `contains` and `ncontains` are case-insensitive. `ncontains` also matches items where the field is empty or not set.
+
+ `exists=true` matches items where the field has a value. `exists=false` matches items where the field is missing or null. For `Switch` fields, `false` is still a set value.
+
+ Value formats:
+
+ | Field type | Value format |
+ | --- | --- |
+ | `Number` | A valid number, such as `10` or `12.5` |
+ | `Switch` | `true` or `false` |
+ | `DateTime` | ISO 8601 date-time string |
+ | `id`, `Reference` | 24-character item ID |
+ | `Option` | Option ID |
+ | `in`, `nin` | Comma-separated list, up to 100 values |
+
+ Invalid fields, invalid values, and operators that do not apply to a field type return a `400 BadArgument` response.
+
sort_by : typing.Optional[ItemsListItemsLiveRequestSortBy]
Sort results by the provided value
sort_order : typing.Optional[ItemsListItemsLiveRequestSortOrder]
Sorts the results by asc or desc
+ sort : typing.Optional[typing.Dict[str, typing.Optional[ItemsListItemsLiveRequestSortValue]]]
+ Sort collection items by custom fields using bracket notation: `sort[]=`.
+
+ - Example: `sort[price]=desc`
+ - Multiple sort fields are applied in query-string order. When `sort[...]` is provided, it takes precedence over `sortBy` and `sortOrder`.
+ - Sortable field types: `PlainText`, `Email`, `Phone`, `Number`, `DateTime`, and `Switch`.
+ - Unknown fields, invalid sort directions, and non-sortable field types return a `400 BadArgument` response.
+
+ translatable : typing.Optional[str]
+ Unique identifier for the secondary Locale you're translating **into**. Returns only content that hasn't been excluded from translation for that locale.
+
+ This is independent of `localeId`, which selects which version of the content is returned. To fetch the source text to translate, request the primary locale's content and set `translatable` to the locale you're translating into:
+
+ `?localeId={primary locale id}&translatable={target locale id}`
+
+ Only exclusion rules scoped to manual translation are respected — rules scoped only to automatic translation don't affect this parameter's response.
+
+ Omitting `translatable` returns the same response as if this parameter didn't exist. The value must be the id of one of the site's secondary locales — the primary locale id, or any other value, returns a `400` error. Requires translation exclusions to be enabled for the site; if they aren't, the request returns a `403` error.
+
+ [Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
+
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -410,8 +646,9 @@ def list_items_live(
limit=1,
name="name",
slug="slug",
- sort_by="lastPublished",
+ sort_by="createdOn",
sort_order="asc",
+ translatable="65427cf400e02b306eaa04a0",
)
"""
_response = self._raw_client.list_items_live(
@@ -421,9 +658,14 @@ def list_items_live(
limit=limit,
name=name,
slug=slug,
+ created_on=created_on,
last_published=last_published,
+ last_updated=last_updated,
+ filter=filter,
sort_by=sort_by,
sort_order=sort_order,
+ sort=sort,
+ translatable=translatable,
request_options=request_options,
)
return _response.data
@@ -437,11 +679,43 @@ def create_item_live(
request_options: typing.Optional[RequestOptions] = None,
) -> CollectionItem:
"""
- Create item(s) in a collection that will be immediately published to the live site.
-
+
+ Rich Text field values can contain Webflow component instances as `` markup — see [Components in Rich Text](/data/docs/working-with-the-cms/components-in-rich-text) for the markup grammar, how to find component and property IDs, and the write constraints.
+
- To create items across multiple locales, [please use this endpoint.](/data/reference/cms/collection-items/staged-items/create-items)
+ Create item(s) in a collection that will be immediately published to the live site.
+ This endpoint accepts two request shapes, and a request must use one or the other:
+
+ - **Single item** — send `fieldData` at the top level. Set `cmsLocaleId` to create the item in a specific locale.
+ - **Multiple items** — send an `items` array with at least one entry. Each entry needs its own `fieldData`, and can set its own `cmsLocaleId`, `isDraft`, and `isArchived`. The API ignores any other property on an entry.
+
+ ```json
+ {
+ "items": [
+ {
+ "isArchived": false,
+ "isDraft": false,
+ "fieldData": {
+ "name": "Senior Data Analyst",
+ "slug": "senior-data-analyst"
+ }
+ },
+ {
+ "isArchived": false,
+ "isDraft": false,
+ "fieldData": {
+ "name": "Product Manager",
+ "slug": "product-manager"
+ }
+ }
+ ]
+ }
+ ```
+
+ A request that carries both `fieldData` and `items` returns a `400`.
+
+ To create items in several locales, use [Create Items](/data/reference/cms/collection-items/staged-items/create-items) and then [Publish Collection Item(s)](/data/reference/cms/collection-items/staged-items/publish-item). Create Items writes staged content only.
Required scope | `CMS:write`
@@ -547,6 +821,10 @@ def update_items_live(
request_options: typing.Optional[RequestOptions] = None,
) -> CollectionItemListNoPagination:
"""
+
+ Rich Text field values can contain Webflow component instances as `` markup — see [Components in Rich Text](/data/docs/working-with-the-cms/components-in-rich-text) for the markup grammar, how to find component and property IDs, and the write constraints.
+
+
Update a single published item or multiple published items (up to 100) in a Collection
Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request.
@@ -638,8 +916,16 @@ def create_items(
request_options: typing.Optional[RequestOptions] = None,
) -> BulkCollectionItem:
"""
+
+ Rich Text field values can contain Webflow component instances as `` markup — see [Components in Rich Text](/data/docs/working-with-the-cms/components-in-rich-text) for the markup grammar, how to find component and property IDs, and the write constraints.
+
+
Create an item or multiple items in a CMS Collection across multiple corresponding locales.
+
+ This endpoint remains supported. New integrations should use [Create Items](/data/reference/cms/collection-items/staged-items/create-items), which does everything this endpoint does and can also add locale variants to an existing item. [This guide to creating items](/data/docs/working-with-the-cms/create-items) shows how the request shape maps.
+
+
- This endpoint can create up to 100 items in a request.
- If the `cmsLocaleIds` parameter is not included in the request, an item will only be created in the primary locale.
@@ -709,15 +995,115 @@ def create_items(
)
return _response.data
+ def insert_items(
+ self,
+ collection_id: str,
+ *,
+ items: typing.Sequence[InsertCollectionItem],
+ skip_invalid_files: typing.Optional[bool] = None,
+ request_options: typing.Optional[RequestOptions] = None,
+ ) -> ItemsInsertItemsResponse:
+ """
+ Create one or more staged items in a CMS Collection.
+
+ Send an `items` array with `fieldData` for each item. By default, new items are created in the primary locale. To choose other locales or add variants to an existing item, expand the options below.
+
+ - **Publishing:** Set `isDraft: false` to queue an item for the next site publish. Items are created as drafts (`isDraft: true`) by default. To publish individual items, use [Publish Collection Item(s)](/data/reference/cms/collection-items/staged-items/publish-item).
+ - **Request limit:** Up to 100 items, counting every locale variant across all entries. One item in three locales counts as three; an item in the primary locale only counts as one.
+
+ Required scope | `cms:write`
+
+
+
+ Each new item gets one ID. Its locale variants share that ID and the same `fieldData`.
+
+ - **Selected locales:** Set `cmsLocaleIds` to the locale IDs you want to create the item in.
+ - **All site locales:** Set `allCmsLocales: true` to include every current site locale, including the primary locale, without listing IDs.
+ - **Primary locale only:** Omit both `cmsLocaleIds` and `allCmsLocales`.
+
+ Use only one locale selector per entry. `allCmsLocales` is available only for new items and accepts only `true`; omit it instead of sending `false`.
+
+
+
+ Set `id` to an existing item's ID and provide the new locales in `cmsLocaleIds`. The variants reuse that ID. The item must exist and must not already have a variant in any requested locale.
+
+ Send the source content in `fieldData` as a starting point for translators. To provide different content per locale, send multiple entries with the same `id`, each with one locale in `cmsLocaleIds` and its own `fieldData`.
+
+
+
+ These requests return a `400`:
+
+ - Combining `allCmsLocales` with `cmsLocaleIds` (even an empty array) or `id`.
+ - Setting `allCmsLocales` to `false`, a string, or `null`.
+ - Sending unrecognized properties, including singular `cmsLocaleId`. Use `cmsLocaleIds` (plural).
+ - Repeating a locale within one entry, or the same `id`/locale pair across entries.
+
+ Check the response's `message` and `details` for validation errors. Some errors identify an entry, such as `items[2].cmsLocaleIds`. Invalid locale selector combinations return a message with an empty `details` array.
+
+
+
+ Each new item gets one ID. Its locale variants share that ID and the same `fieldData`.
+
+ - **Selected locales:** Set `cmsLocaleIds` to the locale IDs you want to create the item in.
+ - **All site locales:** Set `allCmsLocales: true` to include every current site locale, including the primary locale, without listing IDs.
+ - **Primary locale only:** Omit both `cmsLocaleIds` and `allCmsLocales`.
+
+ Use only one locale selector per entry. `allCmsLocales` is available only for new items and accepts only `true`; omit it instead of sending `false`.
+
+
+
+ Set `id` to an existing item's ID and provide the new locales in `cmsLocaleIds`. The variants reuse that ID. The item must exist and must not already have a variant in any requested locale.
+
+ Send the source content in `fieldData` as a starting point for translators. To provide different content per locale, send multiple entries with the same `id`, each with one locale in `cmsLocaleIds` and its own `fieldData`.
+
+
+
+ These requests return a `400`:
+
+ - Combining `allCmsLocales` with `cmsLocaleIds` (even an empty array) or `id`.
+ - Setting `allCmsLocales` to `false`, a string, or `null`.
+ - Sending unrecognized properties, including singular `cmsLocaleId`. Use `cmsLocaleIds` (plural).
+ - Repeating a locale within one entry, or the same `id`/locale pair across entries.
+
+ Check the response's `message` and `details` for validation errors. Some errors identify an entry, such as `items[2].cmsLocaleIds`. Invalid locale selector combinations return a message with an empty `details` array.
+
+
+
+ Each new item gets one ID. Its locale variants share that ID and the same `fieldData`.
+
+ - **Selected locales:** Set `cmsLocaleIds` to the locale IDs you want to create the item in.
+ - **All site locales:** Set `allCmsLocales: true` to include every current site locale, including the primary locale, without listing IDs.
+ - **Primary locale only:** Omit both `cmsLocaleIds` and `allCmsLocales`.
+
+ Use only one locale selector per entry. `allCmsLocales` is available only for new items and accepts only `true`; omit it instead of sending `false`.
+
+
+
+ Set `id` to an existing item's ID and provide the new locales in `cmsLocaleIds`. The variants reuse that ID. The item must exist and must not already have a variant in any requested locale.
+
+ Send the source content in `fieldData` as a starting point for translators. To provide different content per locale, send multiple entries with the same `id`, each with one locale in `cmsLocaleIds` and its own `fieldData`.
+
+
+
+ These requests return a `400`:
+
+ - Combining `allCmsLocales` with `cmsLocaleIds` (even an empty array) or `id`.
+ - Setting `allCmsLocales` to `false`, a string, or `null`.
+ - Sending unrecognized properties, including singular `cmsLocaleId`. Use `cmsLocaleIds` (plural).
+ - Repeating a locale within one entry, or the same `id`/locale pair across entries.
+
+ Check the response's `message` and `details` for validation errors. Some errors identify an entry, such as `items[2].cmsLocaleIds`. Invalid locale selector combinations return a message with an empty `details` array.
+
+
+
+ Each new item gets one ID. Its locale variants share that ID and the same `fieldData`.
+
+ - **Selected locales:** Set `cmsLocaleIds` to the locale IDs you want to create the item in.
+ - **All site locales:** Set `allCmsLocales: true` to include every current site locale, including the primary locale, without listing IDs.
+ - **Primary locale only:** Omit both `cmsLocaleIds` and `allCmsLocales`.
+
+ Use only one locale selector per entry. `allCmsLocales` is available only for new items and accepts only `true`; omit it instead of sending `false`.
+
+
+
+ Set `id` to an existing item's ID and provide the new locales in `cmsLocaleIds`. The variants reuse that ID. The item must exist and must not already have a variant in any requested locale.
+
+ Send the source content in `fieldData` as a starting point for translators. To provide different content per locale, send multiple entries with the same `id`, each with one locale in `cmsLocaleIds` and its own `fieldData`.
+
+
+
+ These requests return a `400`:
+
+ - Combining `allCmsLocales` with `cmsLocaleIds` (even an empty array) or `id`.
+ - Setting `allCmsLocales` to `false`, a string, or `null`.
+ - Sending unrecognized properties, including singular `cmsLocaleId`. Use `cmsLocaleIds` (plural).
+ - Repeating a locale within one entry, or the same `id`/locale pair across entries.
+
+ Check the response's `message` and `details` for validation errors. Some errors identify an entry, such as `items[2].cmsLocaleIds`. Invalid locale selector combinations return a message with an empty `details` array.
+
+