[ { "name": "_", "desc": "API Root\nEntry point to traverse the API endpoints.", "method": "get", "path": "/", "params": [] }, { "name": "_analytics_url_shortener_shortened_urls", "desc": "Get all account-specific shortened URLs\nGet all account-specific shortened URLs", "method": "get", "path": "/analytics/url_shortener/shortened_urls", "params": [ { "name": "site_id", "in": "query", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "post_content_check", "desc": "Upload content for an on-demand content check\nUpload content for an on-demand content check", "method": "post", "path": "/content/check", "params": [] }, { "name": "_content_checks_a11y_issue_on_page", "desc": "Get the a11y issues found in the content \nGet the a11y issues found in the content\n", "method": "get", "path": "/content/checks/{content_id}/a11y/issue_on_page", "params": [ { "name": "content_id", "in": "path", "description": "The content id returned when the content was uploaded", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "_content_checks_issues", "desc": "Get issue found for this page\nGet the full list of content-check issue found for this page.", "method": "get", "path": "/content/checks/{content_id}/issues", "params": [ { "name": "content_id", "in": "path", "description": "The content id returned when the content was uploaded", "required": true, "type": "integer", "format": "int64" } ] }, { "name": "_content_checks_policy_matching_policies", "desc": "Get the matching policies for the content\nGet the matching policies for the content", "method": "get", "path": "/content/checks/{content_id}/policy/matching_policies", "params": [ { "name": "content_id", "in": "path", "description": "The content id returned when the content was uploaded", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "_content_checks_qa_inventory_capture_tags", "desc": "Get the capture tags found in the content\nGet the capture tags found in the content", "method": "get", "path": "/content/checks/{content_id}/quality_assurance/inventory/capture_tags", "params": [ { "name": "content_id", "in": "path", "description": "The content id returned when the content was uploaded", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "_content_checks_qa_inventory_email_addresses", "desc": "Get the email addresses found in the content\nGet the email addresses found in the content", "method": "get", "path": "/content/checks/{content_id}/quality_assurance/inventory/email_addresses", "params": [ { "name": "content_id", "in": "path", "description": "The content id returned when the content was uploaded", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "_content_checks_qa_inventory_link_texts", "desc": "Get the link texts found in the content\nGet the link texts found in the content", "method": "get", "path": "/content/checks/{content_id}/quality_assurance/inventory/link_texts", "params": [ { "name": "content_id", "in": "path", "description": "The content id returned when the content was uploaded", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "_content_checks_qa_inventory_links", "desc": "Get the links found in the content\nGet the links found in the content", "method": "get", "path": "/content/checks/{content_id}/quality_assurance/inventory/links", "params": [ { "name": "content_id", "in": "path", "description": "The content id returned when the content was uploaded", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "_content_checks_qa_inventory_meta_tags", "desc": "Get the meta tags found in the content\nGet the meta tags found in the content", "method": "get", "path": "/content/checks/{content_id}/quality_assurance/inventory/meta_tags", "params": [ { "name": "content_id", "in": "path", "description": "The content id returned when the content was uploaded", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "_content_checks_qa_inventory_personal_id_hfq5vd", "desc": "Get the personal id numbers found in the content\nGet the personal id numbers found in the content", "method": "get", "path": "/content/checks/{content_id}/quality_assurance/inventory/personal_id_numbers", "params": [ { "name": "content_id", "in": "path", "description": "The content id returned when the content was uploaded", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "_content_checks_qa_inventory_phone_numbers", "desc": "Get the phone numbers found in the content\nGet the phone numbers found in the content", "method": "get", "path": "/content/checks/{content_id}/quality_assurance/inventory/phone_numbers", "params": [ { "name": "content_id", "in": "path", "description": "The content id returned when the content was uploaded", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "_content_checks_qa_inventory_trademarks", "desc": "Get the trademarks found in the content\nGet the trademarks found in the content", "method": "get", "path": "/content/checks/{content_id}/quality_assurance/inventory/trademarks", "params": [ { "name": "content_id", "in": "path", "description": "The content id returned when the content was uploaded", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "_content_checks_qa_links_broken_links", "desc": "Get the broken links found in the content\nGet the broken links found in the content", "method": "get", "path": "/content/checks/{content_id}/quality_assurance/links/broken_links", "params": [ { "name": "content_id", "in": "path", "description": "The content id returned when the content was uploaded", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "_content_checks_qa_links_unsafe_domains", "desc": "Get the list of links to unsafe domains found in the content\nGet the list of links to unsafe domains found in the content", "method": "get", "path": "/content/checks/{content_id}/quality_assurance/links/unsafe_domains", "params": [ { "name": "content_id", "in": "path", "description": "The content id returned when the content was uploaded", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "_content_checks_qa_readability", "desc": "Get detailed information of the readability scores of the content for the various metrics\nGet detailed information of the readability scores of the content for the various metrics", "method": "get", "path": "/content/checks/{content_id}/quality_assurance/readability", "params": [ { "name": "content_id", "in": "path", "description": "The content id returned when the content was uploaded", "required": true, "type": "integer", "format": "int64" } ] }, { "name": "_content_checks_qa_spelling_languages", "desc": "Get the languages found in the content\nLists the languages that was detected in the content, along with info about the percentage of the total content is in that language, and whether spellchecking is supported for the language.", "method": "get", "path": "/content/checks/{content_id}/quality_assurance/spelling/languages", "params": [ { "name": "content_id", "in": "path", "description": "The content id returned when the content was uploaded", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "_content_checks_qa_spelling_misspellings", "desc": "Get the misspellings found in the content\nGet the misspellings found in the content", "method": "get", "path": "/content/checks/{content_id}/quality_assurance/spelling/misspellings", "params": [ { "name": "content_id", "in": "path", "description": "The content id returned when the content was uploaded", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "_content_checks_qa_spelling_potential_mi_agoonx", "desc": "Get the potential misspellings found in the content\nGet the potential misspellings found in the content", "method": "get", "path": "/content/checks/{content_id}/quality_assurance/spelling/potential_misspellings", "params": [ { "name": "content_id", "in": "path", "description": "The content id returned when the content was uploaded", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "_content_checks_seov2_issues", "desc": "Get a list of SEO issues found in the content\nGet a list of SEO issues found in the content", "method": "get", "path": "/content/checks/{content_id}/seov2/issues", "params": [ { "name": "content_id", "in": "path", "description": "The content id returned when the content was uploaded", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "_content_checks_summary", "desc": "Get a summary of the findings of the content check\nGet a summary of the findings of the content check", "method": "get", "path": "/content/checks/{content_id}/summary", "params": [ { "name": "content_id", "in": "path", "description": "The content id returned when the content was uploaded", "required": true, "type": "integer", "format": "int64" } ] }, { "name": "_content_unpublish_impact", "desc": "Get unpublishing impact for a page via Url\nGet all information for this page that will be impacted in case of unpublishing it.", "method": "get", "path": "/content/unpublish_impact", "params": [ { "name": "url", "in": "query", "description": "Url of the site", "required": true, "type": "string" } ] }, { "name": "_gdpr_domains_and_ip_addresses", "desc": "Get GDPR-info for all domains\nGet all available GDPR-information about the domains, IP-addresses, and subdomains related to the account.", "method": "get", "path": "/gdpr/domains_and_ip_addresses/domains", "params": [ { "name": "domain_status", "in": "query", "description": "Domain status to show confirmed, uncertain or rejected domains.", "required": false, "type": "string", "enum": [ "confirmed", "unconfirmed", "rejected" ], "default": "confirmed" }, { "name": "is_top_level", "in": "query", "description": "True for \"a.com\" and \"b.co.uk\" but false for \"c.d.com\" and \"e.f.co.uk\".", "required": false, "type": "boolean" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "_gdpr_domains_and_ip_addresses_", "desc": "Get GDPR-information for a specific domain\nGet information about nameservers, registrant, subdomains etc for a specific domain.", "method": "get", "path": "/gdpr/domains_and_ip_addresses/domains/{domain_id}", "params": [ { "name": "domain_id", "in": "path", "description": "Id for specific domain.", "required": true, "type": "integer", "format": "int64" } ] }, { "name": "_gdpr_domains_and_ip_addresses_subdomains", "desc": "Get GDPR-information about subdomains\nGet information about all subdomains to this domain, inclusive optional redirects.", "method": "get", "path": "/gdpr/domains_and_ip_addresses/domains/{domain_id}/subdomains", "params": [ { "name": "domain_id", "in": "path", "description": "Id for specific domain.", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "_integrations", "desc": "Integrations to external systems\nIntegrations to external systems, Like Jira", "method": "get", "path": "/integrations", "params": [] }, { "name": "_project_management_task_managers_tasks", "desc": "List tasks created for external task management systems\nGet a list of tasks created for external project management systems, linking items from the Siteimprove platform, with tasks in the external systems.", "method": "get", "path": "/integrations/project_management/task_managers/{task_manager}/tasks", "params": [ { "name": "task_manager", "in": "path", "description": "External project management system supported by Siteimprove", "required": true, "type": "string", "enum": [ "jira_cloud", "azure_dev_ops", "jira_on_prem_o_auth", "jira_on_prem_o_auth2" ], "default": "jira_cloud" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "_project_management_task_managers_tasks_", "desc": "Show data for a single task\nShow the details for a single task.", "method": "get", "path": "/integrations/project_management/task_managers/{task_manager}/tasks/{task_id}", "params": [ { "name": "task_manager", "in": "path", "description": "External project management system supported by Siteimprove", "required": true, "type": "string", "enum": [ "jira_cloud", "azure_dev_ops", "jira_on_prem_o_auth", "jira_on_prem_o_auth2" ], "default": "jira_cloud" }, { "name": "task_id", "in": "path", "description": "ID of the task to display", "required": true, "type": "integer", "format": "int64" } ] }, { "name": "_ping_account", "desc": "Test your access to the API service\nReturns \"OK\" if the supplied account credentials gives access to the API endpoints.", "method": "get", "path": "/ping/account", "params": [] }, { "name": "_ping_api", "desc": "Test the connectivity to the API service\nReturns \"OK\" if the server is alive.", "method": "get", "path": "/ping/api", "params": [] }, { "name": "_products_policy_archived_policies", "desc": "Get all archived policies\nAn overview of all archived policies.", "method": "get", "path": "/products/policy/archived_policies", "params": [ { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "post_products_policy_archived_policies_u_7hw4cj", "desc": "Unarchive policy\nUnarchive a policy with a policy id.", "method": "post", "path": "/products/policy/archived_policies/{policy_id}/unarchive", "params": [ { "name": "policy_id", "in": "path", "description": "Id of the policy.", "required": true, "type": "integer", "format": "int64" } ] }, { "name": "_products_policy_policies", "desc": "Get all policies on the account\nAn overview of all policies that have been setup for the account, including their current matches.", "method": "get", "path": "/products/policy/policies", "params": [ { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "post_products_policy_policies_archive", "desc": "Archive policy\nArchive a policy with a policy id.", "method": "post", "path": "/products/policy/policies/{policy_id}/archive", "params": [ { "name": "policy_id", "in": "path", "description": "Id of the policy.", "required": true, "type": "integer", "format": "int64" } ] }, { "name": "_products_policy_policies_sites", "desc": "Get policy matches for all sites on the account\nInformation about all sites on which this policy is active. All such sites will be listed here, even if the policy has no matches for that site; in that case matches will simply be 0.", "method": "get", "path": "/products/policy/policies/{policy_id}/sites", "params": [ { "name": "policy_id", "in": "path", "description": "Id of the policy.", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "_settings", "desc": "Get settings\nOverview of top-level settings endpoints.", "method": "get", "path": "/settings", "params": [] }, { "name": "_settings_analytics_segments", "desc": "Get available segments\nGet the available segments. Segments can be used to segment the data shown by appending the query parameter \"filter_id\".", "method": "get", "path": "/settings/analytics/segments", "params": [ { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "_settings_content_checking", "desc": "Get content-check settings\nGet information about the content-check functionality. This is useful for checking whether the content-check functionality has been enabled yet.", "method": "get", "path": "/settings/content_checking", "params": [] }, { "name": "post_settings_content_checking", "desc": "Enable content-check for this account\nThis will enable content-checking for the account. No content-checking can be performed before this has been called to enable it. It may take a while to fully enable this feature - possibly several minutes.\nAfter enabling content-check using this endpoint, the corresponding GET endpoint can be polled to check for when content-check has been completely enabled and is ready to start accepting content-checks. Like so:\n\n POST /settings/content_checking\n Poll GET /settings/content_checking until content-check is ready\n Now you can check content", "method": "post", "path": "/settings/content_checking", "params": [] }, { "name": "_settings_surveys", "desc": "Get surveys\nGet a list of feedback surveys for this account.", "method": "get", "path": "/settings/surveys", "params": [ { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "_settings_users", "desc": "Get users\nGet a list of users for this account.", "method": "get", "path": "/settings/users", "params": [ { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "sites", "desc": "Get sites\nGet a list of sites for this account.", "method": "get", "path": "/sites", "params": [ { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "post_sites", "desc": "Creates a site\nCreates a site with the specified argument values", "method": "post", "path": "/sites", "params": [ { "name": "name", "in": "query", "description": "Site name", "required": true, "type": "string" }, { "name": "url", "in": "query", "description": "Url of the site", "required": true, "type": "string" } ] }, { "name": "sites_", "desc": "Get list of top level endpoints for site\nList of all the possible top-end endpoints, grouped by products and sections.", "method": "get", "path": "/sites/{site_id}", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "a11y_issue_kinds_confirmed_issues", "desc": "Get confirmed accessibility issues\nRetrieves the confirmed accessibility issues; how many pages that have the Issue; how many occurrences of the Issue exist on site in total; its Conformance and Difficulty rating.", "method": "get", "path": "/sites/{site_id}/a11y/issue_kinds/confirmed/issues", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "conformance", "in": "query", "description": "Conformance filter", "required": false, "type": "array", "items": { "type": "string" }, "enum": [ "a", "aa", "aaa", "aria", "si", "unkown" ], "default": [ "a" ] }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "a11y_issue_kinds_confirmed_issues_pages", "desc": "Get pages with confirmed occurrences of this accessibility issue\nRetrieves pages with this confirmed issue from accessibility; how many occurrences of given issue exist on the page.", "method": "get", "path": "/sites/{site_id}/a11y/issue_kinds/confirmed/issues/{issue_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "issue_id", "in": "path", "description": "Id of the issue to display", "required": true, "type": "integer", "format": "int32" }, { "name": "conformance", "in": "query", "description": "Conformance filter", "required": false, "type": "array", "items": { "type": "string" }, "enum": [ "a", "aa", "aaa", "aria", "si", "unkown" ], "default": [ "a" ] }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "a11y_issue_kinds_confirmed_issues_progress_hist", "desc": "Get progress for this confirmed accessibility issue\nRetrieves issue progress for accessibility. Returns a list of how many many occurrences of this issue are present on the site and how many pages in total the site has had over time.", "method": "get", "path": "/sites/{site_id}/a11y/issue_kinds/confirmed/issues/{issue_id}/progress/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "issue_id", "in": "path", "description": "Id of the issue to display", "required": true, "type": "integer", "format": "int32" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "a11y_issue_kinds_confirmed_pages", "desc": "Get pages with confirmed accessibility issues\nRetrieves pages from accessibility with confirmed issues; how many issues there are on the page; how many occurrences of issues there are on the page in total.", "method": "get", "path": "/sites/{site_id}/a11y/issue_kinds/confirmed/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "conformance", "in": "query", "description": "Conformance filter", "required": false, "type": "array", "items": { "type": "string" }, "enum": [ "a", "aa", "aaa", "aria", "si", "unkown" ], "default": [ "a" ] }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "a11y_issue_kinds_confirmed_pages_issues", "desc": "Get confirmed accessibility issues on this page\nRetrieves confirmed Accessibility issues for a given page; occurrences of the Issue, Conformance of the Issue and its Difficulty rating.", "method": "get", "path": "/sites/{site_id}/a11y/issue_kinds/confirmed/pages/{page_id}/issues", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "integer", "format": "int64" }, { "name": "conformance", "in": "query", "description": "Conformance filter", "required": false, "type": "array", "items": { "type": "string" }, "enum": [ "a", "aa", "aaa", "aria", "si", "unkown" ], "default": [ "a" ] }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "a11y_issue_kinds_passed_issues", "desc": "Get passed accessibility issues\nRetrieves the passed accessibility issues; how many pages that have the Issue; how many occurrences of the Issue exist on site in total; its Conformance and Difficulty rating.", "method": "get", "path": "/sites/{site_id}/a11y/issue_kinds/passed/issues", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "conformance", "in": "query", "description": "Conformance filter", "required": false, "type": "array", "items": { "type": "string" }, "enum": [ "a", "aa", "aaa", "aria", "si", "unkown" ], "default": [ "a" ] }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "a11y_issue_kinds_passed_issues_pages", "desc": "Get pages with passed occurrences of this accessibility issue\nRetrieves pages with this passed issue from accessibility; how many occurrences of given issue exist on the page.", "method": "get", "path": "/sites/{site_id}/a11y/issue_kinds/passed/issues/{issue_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "issue_id", "in": "path", "description": "Id of the issue to display", "required": true, "type": "integer", "format": "int32" }, { "name": "conformance", "in": "query", "description": "Conformance filter", "required": false, "type": "array", "items": { "type": "string" }, "enum": [ "a", "aa", "aaa", "aria", "si", "unkown" ], "default": [ "a" ] }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "a11y_issue_kinds_passed_issues_progress_hist", "desc": "Get progress for this passed accessibility issue\nRetrieves issue progress for accessibility. Returns a list of how many many occurrences of this issue are present on the site and how many pages in total the site has had over time.", "method": "get", "path": "/sites/{site_id}/a11y/issue_kinds/passed/issues/{issue_id}/progress/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "issue_id", "in": "path", "description": "Id of the issue to display", "required": true, "type": "integer", "format": "int32" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "a11y_issue_kinds_passed_pages", "desc": "Get pages with passed accessibility issues\nRetrieves pages from accessibility with passed issues; how many issues there are on the page; how many occurrences of issues there are on the page in total.", "method": "get", "path": "/sites/{site_id}/a11y/issue_kinds/passed/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "conformance", "in": "query", "description": "Conformance filter", "required": false, "type": "array", "items": { "type": "string" }, "enum": [ "a", "aa", "aaa", "aria", "si", "unkown" ], "default": [ "a" ] }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "a11y_issue_kinds_passed_pages_issues", "desc": "Get passed accessibility issues on this page\nRetrieves passed Accessibility issues for a given page; occurrences of the Issue, Conformance of the Issue and its Difficulty rating.", "method": "get", "path": "/sites/{site_id}/a11y/issue_kinds/passed/pages/{page_id}/issues", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "integer", "format": "int64" }, { "name": "conformance", "in": "query", "description": "Conformance filter", "required": false, "type": "array", "items": { "type": "string" }, "enum": [ "a", "aa", "aaa", "aria", "si", "unkown" ], "default": [ "a" ] }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "a11y_issue_kinds_potential_issues", "desc": "Get potential accessibility issues\nRetrieves the potential accessibility issues; how many pages that have the Issue; how many occurrences of the Issue exist on site in total; its Conformance and Difficulty rating.", "method": "get", "path": "/sites/{site_id}/a11y/issue_kinds/potential/issues", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "conformance", "in": "query", "description": "Conformance filter", "required": false, "type": "array", "items": { "type": "string" }, "enum": [ "a", "aa", "aaa", "aria", "si", "unkown" ], "default": [ "a" ] }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "a11y_issue_kinds_potential_issues_pages", "desc": "Get pages with potential occurrences of this accessibility issue\nRetrieves pages with this potential issue from accessibility; how many occurrences of given issue exist on the page.", "method": "get", "path": "/sites/{site_id}/a11y/issue_kinds/potential/issues/{issue_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "issue_id", "in": "path", "description": "Id of the issue to display", "required": true, "type": "integer", "format": "int32" }, { "name": "conformance", "in": "query", "description": "Conformance filter", "required": false, "type": "array", "items": { "type": "string" }, "enum": [ "a", "aa", "aaa", "aria", "si", "unkown" ], "default": [ "a" ] }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "a11y_issue_kinds_potential_issues_progress_hist", "desc": "Get progress for this potential accessibility issue\nRetrieves issue progress for accessibility. Returns a list of how many many occurrences of this issue are present on the site and how many pages in total the site has had over time.", "method": "get", "path": "/sites/{site_id}/a11y/issue_kinds/potential/issues/{issue_id}/progress/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "issue_id", "in": "path", "description": "Id of the issue to display", "required": true, "type": "integer", "format": "int32" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "a11y_issue_kinds_potential_pages", "desc": "Get pages with potential accessibility issues\nRetrieves pages from accessibility with potential issues; how many issues there are on the page; how many occurrences of issues there are on the page in total.", "method": "get", "path": "/sites/{site_id}/a11y/issue_kinds/potential/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "conformance", "in": "query", "description": "Conformance filter", "required": false, "type": "array", "items": { "type": "string" }, "enum": [ "a", "aa", "aaa", "aria", "si", "unkown" ], "default": [ "a" ] }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "a11y_issue_kinds_potential_pages_issues", "desc": "Get potential accessibility issues on this page\nRetrieves potential Accessibility issues for a given page; occurrences of the Issue, Conformance of the Issue and its Difficulty rating.", "method": "get", "path": "/sites/{site_id}/a11y/issue_kinds/potential/pages/{page_id}/issues", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "integer", "format": "int64" }, { "name": "conformance", "in": "query", "description": "Conformance filter", "required": false, "type": "array", "items": { "type": "string" }, "enum": [ "a", "aa", "aaa", "aria", "si", "unkown" ], "default": [ "a" ] }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "a11y_overview_groups", "desc": "Get overview of Groups for Accessibility\nRetrieves overview of Groups for Accessibility. Returns the name of the Group; its ID; the number of pages in the group; the number of issues, potential issues, and PDF issues for pages in the Group.", "method": "get", "path": "/sites/{site_id}/a11y/overview/groups", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "conformance", "in": "query", "description": "Conformance filter", "required": false, "type": "array", "items": { "type": "string" }, "enum": [ "a", "aa", "aaa", "aria", "si", "unkown" ], "default": [ "a" ] }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "a11y_overview_progress_compliance_hist", "desc": "Historical scores for A11y compliances.\nThis endpoint returns historical scores for A11y compliances.", "method": "get", "path": "/sites/{site_id}/a11y/overview/progress/compliance/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "a11y_overview_progress_hist", "desc": "Get progress for all issues and occurrences from Accessibility\nRetrieves overall issue and occurrence progress for accessibility. Returns a list of total issues and occurrences present on the site, as well as total pages present. All of the data is filterable by issue type.", "method": "get", "path": "/sites/{site_id}/a11y/overview/progress/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "issue_kind", "in": "query", "description": "Kind of issue state requested (potential, passed or confirmed issues)", "required": false, "type": "string", "enum": [ "confirmed", "potential", "passed" ], "default": "confirmed" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "a11y_overview_site_target_hist", "desc": "Get a history of your site's progress toward its Accessibility site target\nRetrieves insights into your site's accessibility performance and progress toward meeting industry standards and your defined targets.", "method": "get", "path": "/sites/{site_id}/a11y/overview/site_target/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "a11y_overview_site_target_overview", "desc": "Get an overview of your site's progress toward its Accessibility site target\nRetrieves today's insights into your site's accessibility performance toward meeting industry standards and your defined targets.", "method": "get", "path": "/sites/{site_id}/a11y/overview/site_target/overview", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "a11y_overview_summary", "desc": "Get summary for Accessibility\nRetrieves issue overview for accessibility, according to conformance level (A, AA, AAA, WAI-ARIA, accessibility best practices) and issue type. Items that don't contain any issues are not returned.", "method": "get", "path": "/sites/{site_id}/a11y/overview/summary", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "a11y_validation_pdfs", "desc": "Get report on PDF errors from accessibility\nRetrieves PDF documents from accessibility. Contains the PDF documents referred on the site, whether they're tagged, contains text, and their errors", "method": "get", "path": "/sites/{site_id}/a11y/validation/pdfs", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "a11y_validation_pdfs_issues", "desc": "Get errors for specific PDF document\n\n\nList of errors for the PDF document", "method": "get", "path": "/sites/{site_id}/a11y/validation/pdfs/{link_id}/issues", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "link_id", "in": "path", "description": "Id of a specific link/URL.", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "a11y_validation_pdfs_pages_using_pdf", "desc": "Get HTML pages referring to specific PDF document\n\n\nList of HTML pages on the site that refers to the PDF document\n\n", "method": "get", "path": "/sites/{site_id}/a11y/validation/pdfs/{pdf_id}/pages_using_pdf", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "pdf_id", "in": "path", "description": "id of the PDF document", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "analytics_behavior_visit_depth", "desc": "Get visit depth from behavior\nGet the visit depth. Depth relates to the number of page views for each visit. Visits with a high number of page views suggests that the site is encouraging visitors to stay.", "method": "get", "path": "/sites/{site_id}/analytics/behavior/visit_depth", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_behavior_visit_depth_hist", "desc": "Get historical data of visit depth from behavior\nA series of historical data points showing the average amount of page views.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/behavior/visit_depth/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_behavior_visit_length", "desc": "Get visit length from behavior\nGet the length of a visit. Length relates to the duration (in minutes) of each visit.. This data can be used to determine how much your website retains visitor - if the visit length is typically low, you could investigate ways to keep your visitors on your site for longer.", "method": "get", "path": "/sites/{site_id}/analytics/behavior/visit_length", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_behavior_visit_length_hist", "desc": "Get historical data of visit length from behavior\nA series of historical data points showing the average visit length. Length relates to the duration (in minutes) of each visit.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/behavior/visit_length/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_behavior_visits_by_hour", "desc": "Get visits by hour of the day from behavior\nGet the distribution of visits and page views over hours of the day.", "method": "get", "path": "/sites/{site_id}/analytics/behavior/visits_by_hour", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_behavior_visits_by_monthday", "desc": "Get visits by day of the month from behavior\nGet the distribution of visits and page views over day of the month.", "method": "get", "path": "/sites/{site_id}/analytics/behavior/visits_by_monthday", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_behavior_visits_by_weekday", "desc": "Get visits by weekday from behavior\nGet the distribution of visits and page views over weekday.", "method": "get", "path": "/sites/{site_id}/analytics/behavior/visits_by_weekday", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_campaigns_combinations_hist", "desc": "Get historical data for the specific campaign combination\nA series of historical data points showing the amount of visits for the specific campaign combination.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/campaigns/combinations/{name_id}/{source_id}/{medium_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "name_id", "in": "path", "description": "Id for specific campaign name", "required": true, "type": "string" }, { "name": "source_id", "in": "path", "description": "Id for specific campaign source", "required": true, "type": "string" }, { "name": "medium_id", "in": "path", "description": "Id for specific campaign medium", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_campaigns_combinations_pages", "desc": "Get the pages visited by the specific campaign combination\nLists all the pages visited by the specific combination of campaign name, source and medium.", "method": "get", "path": "/sites/{site_id}/analytics/campaigns/combinations/{name_id}/{source_id}/{medium_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "name_id", "in": "path", "description": "Id for specific campaign name", "required": true, "type": "string" }, { "name": "source_id", "in": "path", "description": "Id for specific campaign source", "required": true, "type": "string" }, { "name": "medium_id", "in": "path", "description": "Id for specific campaign medium", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_campaigns_contents", "desc": "Get contents from campaigns\nContent variations in the campaigns used to reach the website. The value in the parameter `utm_content` (or another \"Content\" campaign parameter that has been added).", "method": "get", "path": "/sites/{site_id}/analytics/campaigns/contents", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_campaigns_contents_details", "desc": "Get content details from campaigns\nShows the `name`, `source` and `medium` used in connection with the specified `content`.", "method": "get", "path": "/sites/{site_id}/analytics/campaigns/contents/{parameter_name_id}/{parameter_value_id}/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "parameter_name_id", "in": "path", "description": "Id for specific parameter name.", "required": true, "type": "string" }, { "name": "parameter_value_id", "in": "path", "description": "Id for specific parameter value.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_campaigns_contents_hist", "desc": "Get historical data for specific content from campaigns\nA series of historical data points showing the amount of visits for a specific `content` value.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/campaigns/contents/{parameter_name_id}/{parameter_value_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "parameter_name_id", "in": "path", "description": "Id for specific parameter name.", "required": true, "type": "string" }, { "name": "parameter_value_id", "in": "path", "description": "Id for specific parameter value.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_campaigns_contents_pages", "desc": "Get pages related to specific content from campaigns\nShows the pages where the specified `content` has been used.", "method": "get", "path": "/sites/{site_id}/analytics/campaigns/contents/{parameter_name_id}/{parameter_value_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "parameter_name_id", "in": "path", "description": "Id for specific parameter name.", "required": true, "type": "string" }, { "name": "parameter_value_id", "in": "path", "description": "Id for specific parameter value.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_campaigns_mediums", "desc": "Get mediums from campaigns\nMedium of the campaigns used to reach the website. The value in the parameter `utm_medium` (or another \"Medium\" campaign parameter that has been added).", "method": "get", "path": "/sites/{site_id}/analytics/campaigns/mediums", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_campaigns_mediums_details", "desc": "Get medium details from campaigns\nShows the `name` and `source` used in connection with the specified `medium`.", "method": "get", "path": "/sites/{site_id}/analytics/campaigns/mediums/{parameter_name_id}/{parameter_value_id}/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "parameter_name_id", "in": "path", "description": "Id for specific parameter name.", "required": true, "type": "string" }, { "name": "parameter_value_id", "in": "path", "description": "Id for specific parameter value.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_campaigns_names", "desc": "Get names from campaigns\nContent variations in the campaigns used to reach the website. The value in the parameter utm_name (or another \"Name\" campaign parameter that has been added).", "method": "get", "path": "/sites/{site_id}/analytics/campaigns/names", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_campaigns_names_details", "desc": "Get name details from campaigns\nShows the `medium` and `source` used in connection with the specified `name`.", "method": "get", "path": "/sites/{site_id}/analytics/campaigns/names/{parameter_name_id}/{parameter_value_id}/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "parameter_name_id", "in": "path", "description": "Id for specific parameter name.", "required": true, "type": "string" }, { "name": "parameter_value_id", "in": "path", "description": "Id for specific parameter value.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_campaigns_pages", "desc": "Get pages from campaigns\nGet pages which have been reached as part of a campaign.", "method": "get", "path": "/sites/{site_id}/analytics/campaigns/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_campaigns_pages_details", "desc": "Get details for specific page from campaigns\nShows the `name`, `source` and `medium` used in connection with the specified page.", "method": "get", "path": "/sites/{site_id}/analytics/campaigns/pages/{page_id}/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_campaigns_pages_hist", "desc": "Get historical data for a specific page in campaigns\nA series of historical data points showing the amount of visits for a specific `page`.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/campaigns/pages/{page_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_campaigns_sources", "desc": "Get sources from campaigns\nSource of the campaigns used to reach the website. The value in the parameter `utm_source` (or another \"Source\" campaign parameter that has been added).", "method": "get", "path": "/sites/{site_id}/analytics/campaigns/sources", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_campaigns_sources_details", "desc": "Get source details from campaigns\nShows the `name` and `medium` used in connection with the specified `source`.", "method": "get", "path": "/sites/{site_id}/analytics/campaigns/sources/{parameter_name_id}/{parameter_value_id}/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "parameter_name_id", "in": "path", "description": "Id for specific parameter name.", "required": true, "type": "string" }, { "name": "parameter_value_id", "in": "path", "description": "Id for specific parameter value.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_campaigns_summary", "desc": "Get summary of campaigns\nLists the campaigns used to reach the website.", "method": "get", "path": "/sites/{site_id}/analytics/campaigns/summary", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_campaigns_summary_hist", "desc": "Get historical data of all campaigns\nA series of historical data points showing the amount of visits for all campaigns.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/campaigns/summary/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_campaigns_terms", "desc": "Get terms from campaigns\nThe terms of the campaigns used to reach the website. The value in the parameter `utm_term` (or another \"Term\" campaign parameter that has been added).", "method": "get", "path": "/sites/{site_id}/analytics/campaigns/terms", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_campaigns_terms_details", "desc": "Get term details from campaigns\nShows the `name`, `source` and `medium` used in connection with the specified `term`.", "method": "get", "path": "/sites/{site_id}/analytics/campaigns/terms/{parameter_name_id}/{parameter_value_id}/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "parameter_name_id", "in": "path", "description": "Id for specific parameter name.", "required": true, "type": "string" }, { "name": "parameter_value_id", "in": "path", "description": "Id for specific parameter value.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_content_all_pages", "desc": "Get all pages from content\nGet all pages identified on your site.\n\nNote that if your site only has group access then group_id is required, not optional.", "method": "get", "path": "/sites/{site_id}/analytics/content/all_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_content_entry_pages", "desc": "Get entry pages from content\nAn entry page is the first page a visitor sees when they enter the website.", "method": "get", "path": "/sites/{site_id}/analytics/content/entry_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_content_exit_pages", "desc": "Get exit pages from content\nAn exit page is the last page a visitor sees before they leave the website.", "method": "get", "path": "/sites/{site_id}/analytics/content/exit_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_content_least_popular_pages", "desc": "Get least popular pages from content\nGet the least popular pages among the top 1000 pages with the most page views.", "method": "get", "path": "/sites/{site_id}/analytics/content/least_popular_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_content_most_popular_pages", "desc": "Get most popular pages from content\nGet the most popular pages among the top 1000 pages with the most page views.", "method": "get", "path": "/sites/{site_id}/analytics/content/most_popular_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_content_navigation_depth", "desc": "Get navigation depth from content\nGet the average number of clicks (pages visited) to get to a certain page.", "method": "get", "path": "/sites/{site_id}/analytics/content/navigation_depth", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_content_outbound_links", "desc": "Get outbound links from content\nGet links to external domains, that have been used to leave your site.", "method": "get", "path": "/sites/{site_id}/analytics/content/outbound_links", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_content_outbound_links_hist", "desc": "Get historical data for specific outbound link from content\nA series of historical data points showing the amount of visits for a specific outbound link.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/content/outbound_links/{outbound_link_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "outbound_link_id", "in": "path", "description": "Id for specific outbound link/URL.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_content_outbound_links_pages", "desc": "Get pages for specific outbound link from content\nGet the pages where the specified outbound link has been used", "method": "get", "path": "/sites/{site_id}/analytics/content/outbound_links/{outbound_link_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "outbound_link_id", "in": "path", "description": "Id for specific outbound link/URL.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_content_page_load_time", "desc": "Get page load time from content\nGet the average amount of time (in seconds) it takes a page to load.", "method": "get", "path": "/sites/{site_id}/analytics/content/page_load_time", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_content_pages_without_visits", "desc": "Get pages without visits from content\nGet the pages that have had no visits in the selected time period.\n\nOnly pages that meet ALL of the criteria listed below will be included: \n* The page must have the Siteimprove Analytics script. \n* The page must have Analytics/Quality Assurance integration - i.e. the page must be found in both QA and Analytics and have a match established between them. \n* The page must have been found in the latest Quality Assurance crawl. \n* The page must have had no visits in the selected time period with any chosen filter and group. \n* If the page registered in Quality Assurance has multiple Analytics link matches (in case of a parameter exclusion, for example), the page will only be included if none of these links have had any visits.\n\nThese criteria make sure that pages included in the list with relative certainty have NOT had any visits during the selected time period.", "method": "get", "path": "/sites/{site_id}/analytics/content/pages_without_visits", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_content_parameters", "desc": "Get parameters from content\nVisits and page view statistics for all parameters that have been setup.", "method": "get", "path": "/sites/{site_id}/analytics/content/parameters", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Filter the parameter names (applied as \\*[query]\\*).", "required": false, "type": "string" } ] }, { "name": "analytics_content_parameters_hist", "desc": "Get historical data for specific parameter from content\nA series of historical data points showing the amount of visits for a specific parameter. When viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/content/parameters/{parameter_name_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "parameter_name_id", "in": "path", "description": "Id for specific parameter name.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_content_parameters_pages", "desc": "Get pages for specific parameter from content\nGet the pages where the specified parameter have been collected.", "method": "get", "path": "/sites/{site_id}/analytics/content/parameters/{parameter_name_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "parameter_name_id", "in": "path", "description": "Id for specific parameter name.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_content_parameters_values", "desc": "Get values for specific parameter from content\nGet the collected values for the specified parameter.", "method": "get", "path": "/sites/{site_id}/analytics/content/parameters/{parameter_name_id}/values", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "parameter_name_id", "in": "path", "description": "Id for specific parameter name.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Filter the values (applied as \\*[query]\\*).", "required": false, "type": "string" } ] }, { "name": "analytics_content_parameters_values_hist", "desc": "Get historical data for specific parameter value from campaigns\nA series of historical data points showing the amount of visits for a specific parameter value.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/content/parameters/{parameter_name_id}/values/{parameter_value_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "parameter_name_id", "in": "path", "description": "Id for specific parameter name.", "required": true, "type": "string" }, { "name": "parameter_value_id", "in": "path", "description": "Id for specific parameter value.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_content_parameters_values_pages", "desc": "Get pages for specific parameter value from content\nGet the pages where the specified parameter value have been collected.", "method": "get", "path": "/sites/{site_id}/analytics/content/parameters/{parameter_name_id}/values/{parameter_value_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "parameter_name_id", "in": "path", "description": "Id for specific parameter name.", "required": true, "type": "string" }, { "name": "parameter_value_id", "in": "path", "description": "Id for specific parameter value.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_entries_exits_bounce_rates", "desc": "Get bounce rates from entries and exits\nList of pages with bounces and bounce rate.", "method": "get", "path": "/sites/{site_id}/analytics/entries_exits/bounce_rates", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_entries_exits_entry_exit_rates", "desc": "Get entry and exit rates from entries and exits\nList the amount of entries and exits registered for your pages.", "method": "get", "path": "/sites/{site_id}/analytics/entries_exits/entry_exit_rates", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_entries_exits_entry_exit_rates_5q7jxu", "desc": "Get last outbound links for specific exit page from entries and exits\nThe last outbound links and their amount of clicks for a specific exit page.", "method": "get", "path": "/sites/{site_id}/analytics/entries_exits/entry_exit_rates/{page_id}/last_outbound_links", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_events_actions", "desc": "Get actions from event tracking\nGet all the event actions performed on your website.", "method": "get", "path": "/sites/{site_id}/analytics/event_tracking/actions", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_events_categories", "desc": "Get categories from event tracking\nGet all the event categories. Categories are used to group events in logical clusters, such as videos, contact, forms etc.", "method": "get", "path": "/sites/{site_id}/analytics/event_tracking/categories", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_events_categories_actions", "desc": "Get actions for specific category from event tracking\nGet the `actions` that have been used in connection with a specific `category`.", "method": "get", "path": "/sites/{site_id}/analytics/event_tracking/categories/{category_id}/actions", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "category_id", "in": "path", "description": "Id of a specific category.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_events_categories_actions_labels", "desc": "Get labels for specific pair of category and action from event tracking\nGet the `labels` that have been used in connection with the specified `category` and `action`.", "method": "get", "path": "/sites/{site_id}/analytics/event_tracking/categories/{category_id}/actions/{action_id}/labels", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "category_id", "in": "path", "description": "Id of a specific category.", "required": true, "type": "string" }, { "name": "action_id", "in": "path", "description": "Id of a specific action.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_events_events", "desc": "Get events from event tracking\nGet the events that have been triggered within the chosen period.", "method": "get", "path": "/sites/{site_id}/analytics/event_tracking/events", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_events_events_hist", "desc": "Get historical data for events from event tracking\nA series of historical data points showing the amount of events, visits and pages.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/event_tracking/events/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_events_events_pages", "desc": "Get pages for specific event from event tracking\nGet the pages where the specified event have been triggered.", "method": "get", "path": "/sites/{site_id}/analytics/event_tracking/events/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "action_id", "in": "query", "description": "Id of a specific action.", "required": false, "type": "string" }, { "name": "category_id", "in": "query", "description": "Id of a specific category.", "required": false, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "label_id", "in": "query", "description": "Id of a specific label.", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_events_labels", "desc": "Get labels from event tracking\nGet all the event labels. Labels are used to see specifics about an event.", "method": "get", "path": "/sites/{site_id}/analytics/event_tracking/labels", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_events_labels_events", "desc": "Get label details from event tracking\nGet the `action` and `category` pairs that have been used in connection with the specified `label`.", "method": "get", "path": "/sites/{site_id}/analytics/event_tracking/labels/{label_id}/events", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "label_id", "in": "path", "description": "Id of a specific label.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_events_pages", "desc": "Get pages from event tracking\nGet all the pages where an event have been triggered.", "method": "get", "path": "/sites/{site_id}/analytics/event_tracking/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_events_pages_events", "desc": "Get event details for specific page from event tracking\nGet the event details for a specific page.", "method": "get", "path": "/sites/{site_id}/analytics/event_tracking/pages/{page_id}/events", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_events_pages_hist", "desc": "Get historical data for specific page from event tracking\nA series of historical data points showing the amount of events for the specified page.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/event_tracking/pages/{page_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_internal_searches", "desc": "Get internal searches\nThe the search terms that your users have entered into your search solution.", "method": "get", "path": "/sites/{site_id}/analytics/internal_searches", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_results", "in": "query", "description": "Filter to see either all search terms or only those that did or did not find a result.", "required": false, "type": "string", "enum": [ "all", "with_results", "without_results" ], "default": "all" } ] }, { "name": "analytics_internal_searches_hist", "desc": "Get historical data from internal searches\nA series of historical data points showing the amount of visits, searches and exists.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/internal_searches/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_results", "in": "query", "description": "Filter to see either all search terms or only those that did or did not find a result.", "required": false, "type": "string", "enum": [ "all", "with_results", "without_results" ], "default": "all" } ] }, { "name": "analytics_internal_searches_search_terms_py5djh", "desc": "Get actions for specific search term from internal searches\nGet the actions performed by the user after searching for the specified search term.", "method": "get", "path": "/sites/{site_id}/analytics/internal_searches/search_terms/{search_term_id}/actions", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "search_term_id", "in": "path", "description": "Id of a specific search term.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_keymetrics_categories", "desc": "Get categories\nThe available categories for use with Key Metrics.", "method": "get", "path": "/sites/{site_id}/analytics/keymetrics/categories", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_keymetrics_kpis", "desc": "Get Key Performance Indicators\nThe Key Performance Indicators for use with Key Metrics.", "method": "get", "path": "/sites/{site_id}/analytics/keymetrics/kpis", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_keymetrics_metrics", "desc": "Get Key Metrics\nThe Key Metrics.", "method": "get", "path": "/sites/{site_id}/analytics/keymetrics/metrics", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_overview_groups", "desc": "Get analytics groups\nGet the groups available. Groups are used to display statistics for specific sections of the website or a collection of pages.", "method": "get", "path": "/sites/{site_id}/analytics/overview/groups", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_overview_hist", "desc": "Get historical data from overview\nA series of historical data points showing the most common statistics for your site.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/overview/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_overview_online_visitors", "desc": "Get online visitors from overview\nGet the current online visitors.\n\nWill always use the `Now` period.", "method": "get", "path": "/sites/{site_id}/analytics/overview/online_visitors", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_overview_online_visitors_details", "desc": "Get details for online visitor from overview\nGet a detailed view of the specified online visitor.", "method": "get", "path": "/sites/{site_id}/analytics/overview/online_visitors/{session_id}/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "session_id", "in": "path", "description": "Id for specific session.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_overview_online_visitors_pages", "desc": "Get pages for specific online visitor from overview\nGet the pages visited by the specified online visitor.", "method": "get", "path": "/sites/{site_id}/analytics/overview/online_visitors/{session_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "session_id", "in": "path", "description": "Id for specific session.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_overview_summary", "desc": "Get summary for analytics\nGet a summary of the most common statistics for your site.", "method": "get", "path": "/sites/{site_id}/analytics/overview/summary", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_ai_orgs", "desc": "Get AI organizations from traffic sources\nGet the AI organizations that have referred visitors to your website.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/ai_organisations", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_ai_orgs_domains", "desc": "Get domains for AI organization from traffic sources\nGet the referring domains for the specified AI organization.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/ai_organisations/{ai_organisation_id}/domains", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "ai_organisation_id", "in": "path", "description": "The ID of the AI organization.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_ai_orgs_domains_domain_links", "desc": "Get links for specific AI organization domain from traffic sources\nGet the referring links for the specified AI organization domain.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/ai_organisations/{ai_organisation_id}/domains/{domain_id}/domain_links", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "ai_organisation_id", "in": "path", "description": "The ID of the AI organization.", "required": true, "type": "string" }, { "name": "domain_id", "in": "path", "description": "Id for specific domain.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_ai_orgs_domains_domain_links_hist", "desc": "Get historical data for specific AI organization domain link from traffic sources\nA series of historical data points showing the visits for the specified AI organization domain page.\n\nWhen viewing historical data, the resolution of the data points will be dependent on the period specified. For single-day periods, the resolution will be hours. For periods less than 62 days (approximately two months), the resolution will be days. For longer periods, the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/ai_organisations/{ai_organisation_id}/domains/{domain_id}/domain_links/{domain_link_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "ai_organisation_id", "in": "path", "description": "The ID of the AI organization.", "required": true, "type": "string" }, { "name": "domain_id", "in": "path", "description": "Id for specific domain.", "required": true, "type": "string" }, { "name": "domain_link_id", "in": "path", "description": "Id for specific domain link/URL.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_ai_orgs_domains_hist", "desc": "Get historical data for specific AI organization domain from traffic sources\nA series of historical data points showing the visits for the specified AI organization domain.\n\nWhen viewing historical data, the resolution of the data points will be dependent on the period specified. For single-day periods, the resolution will be hours. For periods less than 62 days (approximately two months), the resolution will be days. For longer periods, the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/ai_organisations/{ai_organisation_id}/domains/{domain_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "ai_organisation_id", "in": "path", "description": "The ID of the AI organization.", "required": true, "type": "string" }, { "name": "domain_id", "in": "path", "description": "Id for specific domain.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_ai_orgs_domains_pages", "desc": "Get pages for specific AI organization domain from traffic sources\nGet the pages(s) that was reached from the specified AI organization domain.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/ai_organisations/{ai_organisation_id}/domains/{domain_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "ai_organisation_id", "in": "path", "description": "The ID of the AI organization.", "required": true, "type": "string" }, { "name": "domain_id", "in": "path", "description": "Id for specific domain.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_ai_orgs_domains_pages_hist", "desc": "Get historical data for specific AI organization domain page from traffic sources\nA series of historical data points showing the visits for the specified AI organization domain page.\n\nWhen viewing historical data, the resolution of the data points will be dependent on the period specified. For single-day periods, the resolution will be hours. For periods less than 62 days (approximately two months), the resolution will be days. For longer periods, the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/ai_organisations/{ai_organisation_id}/domains/{domain_id}/pages/{page_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "ai_organisation_id", "in": "path", "description": "The ID of the AI organization.", "required": true, "type": "string" }, { "name": "domain_id", "in": "path", "description": "Id for specific domain.", "required": true, "type": "string" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_ai_orgs_hist", "desc": "Get historical data for specific AI organization from traffic sources\nA series of historical data points showing the visits for the specified AI organization.\n\nWhen viewing historical data, the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months), the resolution will be days. For longer periods, the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/ai_organisations/{ai_organisation_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "ai_organisation_id", "in": "path", "description": "The ID of the AI organization.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_ai_orgs_pages", "desc": "Get pages for specific AI organization from traffic sources\nGet the page(s) that was reached from the specified AI organisation.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/ai_organisations/{ai_organisation_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "ai_organisation_id", "in": "path", "description": "The ID of the AI organization.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_ai_orgs_pages_hist", "desc": "Get historical data for specific AI organization page from traffic sources\nA series of historical data points showing the visits for the specified AI organization page.\n\nWhen viewing historical data, the resolution of the data points will be dependent on the period specified. For single-day periods, the resolution will be hours. For periods less than 62 days (approximately two months), the resolution will be days. For longer periods, the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/ai_organisations/{ai_organisation_id}/pages/{page_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "ai_organisation_id", "in": "path", "description": "The ID of the AI organization.", "required": true, "type": "string" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_direct_entry_pages", "desc": "Get direct traffic from traffic sources\nEntry pages for the visits that have started through a direct entry to your website (for example from a bookmark) and not through an external referrer or search engine.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/direct_traffic_entry_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_direct_entry_pages_hist", "desc": "Get historical data for direct traffic from traffic sources\nA series of historical data points showing the direct traffic from traffic sources.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/direct_traffic_entry_pages/{page_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_external_ref_domains", "desc": "Get external referring domains from traffic sources\nExternal domains that have referred visitors to your website.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/external_referring_domains", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_external_ref_domains_hist", "desc": "Get historical data for external referring domains from traffic sources\nA series of historical data points showing the visits from external domains that have referred visitors to your website.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/external_referring_domains/{domain_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "domain_id", "in": "path", "description": "Id for specific domain.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_external_ref_domains_ref_pages", "desc": "Get referring pages from an external referring domain from traffic sources\nThe referring pages on the chosen external domain, that have referred visitors to your website.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/external_referring_domains/{domain_id}/referring_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "domain_id", "in": "path", "description": "Id for specific domain.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_external_ref_pages", "desc": "Get external referring pages from traffic sources\nPages on external domains that have referred visitors to your website.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/external_referring_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_external_ref_pages_hist", "desc": "Get historical data for external referring pages from traffic sources\nA series of historical data points showing the visits from external pages that have referred visitors to your website.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/external_referring_pages/{external_page_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "external_page_id", "in": "path", "description": "Id for specific external referring page.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_external_ref_pages_landing_pages", "desc": "Get landing pages from external referring pages from traffic sources\nThe landing pages by external pages that have referred visitors to your website.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/external_referring_pages/{external_page_id}/landing_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "external_page_id", "in": "path", "description": "Id for specific external referring page.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_external_ref_pages_landing_pages_hist", "desc": "Get historical data for landing pages from external referring pages from traffic sources\nA series of historical data points showing the visits on landing pages by external pages that have referred visitors to your website.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/external_referring_pages/{external_page_id}/landing_pages/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "external_page_id", "in": "path", "description": "Id for specific external referring page.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_search_eng", "desc": "Get search engines from traffic sources\nSearch engines that have referred visitors to your website.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/search_engines", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_search_eng_domains", "desc": "Get domains for search engines from traffic sources\nGet the referring domains for the specified search engine.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/search_engines/{search_engine_id}/domains", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "search_engine_id", "in": "path", "description": "Id for specific search engine.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_search_eng_domains_domain_links", "desc": "Get links for specific search engine domain from traffic sources\nGet the referring links for the specified search engine domain.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/search_engines/{search_engine_id}/domains/{domain_id}/domain_links", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "search_engine_id", "in": "path", "description": "Id for specific search engine.", "required": true, "type": "string" }, { "name": "domain_id", "in": "path", "description": "Id for specific domain.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_search_eng_domains_domain_links_hist", "desc": "Get historical data for specific search engine domain link from traffic sources\nA series of historical data points showing the visits for the specified search engine domain link.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/search_engines/{search_engine_id}/domains/{domain_id}/domain_links/{domain_link_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "search_engine_id", "in": "path", "description": "Id for specific search engine.", "required": true, "type": "string" }, { "name": "domain_id", "in": "path", "description": "Id for specific domain.", "required": true, "type": "string" }, { "name": "domain_link_id", "in": "path", "description": "Id for specific domain link/URL.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_search_eng_domains_hist", "desc": "Get historical data for specific search engine domain from traffic sources\nA series of historical data points showing the visits for the specified search engine domain.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/search_engines/{search_engine_id}/domains/{domain_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "search_engine_id", "in": "path", "description": "Id for specific search engine.", "required": true, "type": "string" }, { "name": "domain_id", "in": "path", "description": "Id for specific domain.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_search_eng_domains_pages", "desc": "Get pages for specific search engine domain from traffic sources\nGet the pages that was reached from the specified search engine domain.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/search_engines/{search_engine_id}/domains/{domain_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "search_engine_id", "in": "path", "description": "Id for specific search engine.", "required": true, "type": "string" }, { "name": "domain_id", "in": "path", "description": "Id for specific domain.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_search_eng_domains_pages_hist", "desc": "Get historical data for specific search engine domain page from traffic sources\nA series of historical data points showing the visits for the specified search engine domain page.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/search_engines/{search_engine_id}/domains/{domain_id}/pages/{page_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "search_engine_id", "in": "path", "description": "Id for specific search engine.", "required": true, "type": "string" }, { "name": "domain_id", "in": "path", "description": "Id for specific domain.", "required": true, "type": "string" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_search_eng_hist", "desc": "Get historical data for specific search engine from traffic sources\nA series of historical data points showing the visits for the specified search engine.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/search_engines/{search_engine_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "search_engine_id", "in": "path", "description": "Id for specific search engine.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_search_eng_pages", "desc": "Get pages for specific search engine from traffic sources\nGet the pages that was reached from the specified search engine.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/search_engines/{search_engine_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "search_engine_id", "in": "path", "description": "Id for specific search engine.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_search_eng_pages_hist", "desc": "Get historical data for specific search engine page from traffic sources\nA series of historical data points showing the visits for the specified search engine page.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/search_engines/{search_engine_id}/pages/{page_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "search_engine_id", "in": "path", "description": "Id for specific search engine.", "required": true, "type": "string" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_social_orgs", "desc": "Get social media organisations from traffic sources\nGet the social media organisations that have referred visitors to your website.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/social_media_organisations", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_social_orgs_domains", "desc": "Get domains for social media organisation from traffic sources\nGet the referring domains for the specified social media organisation.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/social_media_organisations/{social_media_organisation_id}/domains", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "social_media_organisation_id", "in": "path", "description": "Id for specific social media.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_social_orgs_domains_domain_links", "desc": "Get links for specific social media organisation domain from traffic sources\nGet the referring links for the specified social media organisation domain.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/social_media_organisations/{social_media_organisation_id}/domains/{domain_id}/domain_links", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "social_media_organisation_id", "in": "path", "description": "Id for specific social media.", "required": true, "type": "string" }, { "name": "domain_id", "in": "path", "description": "Id for specific domain.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_social_orgs_domains_domain_links_hist", "desc": "Get historical data for specific social media organisation domain link from traffic sources\nA series of historical data points showing the visits for the specified social media organisation domain link.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/social_media_organisations/{social_media_organisation_id}/domains/{domain_id}/domain_links/{domain_link_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "social_media_organisation_id", "in": "path", "description": "Id for specific social media.", "required": true, "type": "string" }, { "name": "domain_id", "in": "path", "description": "Id for specific domain.", "required": true, "type": "string" }, { "name": "domain_link_id", "in": "path", "description": "Id for specific domain link/URL.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_social_orgs_domains_hist", "desc": "Get historical data for specific social media organisation domain from traffic sources\nA series of historical data points showing the visits for the specified social media organisation domain.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/social_media_organisations/{social_media_organisation_id}/domains/{domain_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "social_media_organisation_id", "in": "path", "description": "Id for specific social media.", "required": true, "type": "string" }, { "name": "domain_id", "in": "path", "description": "Id for specific domain.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_social_orgs_domains_pages", "desc": "Get pages for specific social media organisation domain from traffic sources\nGet the pages that was reached from the specified social media organisation domain.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/social_media_organisations/{social_media_organisation_id}/domains/{domain_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "social_media_organisation_id", "in": "path", "description": "Id for specific social media.", "required": true, "type": "string" }, { "name": "domain_id", "in": "path", "description": "Id for specific domain.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_social_orgs_domains_pages_hist", "desc": "Get historical data for specific social media organisation domain page from traffic sources\nA series of historical data points showing the visits for the specified social media organisation domain page.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/social_media_organisations/{social_media_organisation_id}/domains/{domain_id}/pages/{page_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "social_media_organisation_id", "in": "path", "description": "Id for specific social media.", "required": true, "type": "string" }, { "name": "domain_id", "in": "path", "description": "Id for specific domain.", "required": true, "type": "string" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_social_orgs_hist", "desc": "Get historical data for specific social media organisation from traffic sources\nA series of historical data points showing the visits for the specified social media organisation.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/social_media_organisations/{social_media_organisation_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "social_media_organisation_id", "in": "path", "description": "Id for specific social media.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_social_orgs_pages", "desc": "Get pages for specific social media organisation from traffic sources\nGet the pages that was reached from the specified social media organisation.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/social_media_organisations/{social_media_organisation_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "social_media_organisation_id", "in": "path", "description": "Id for specific social media.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_social_orgs_pages_hist", "desc": "Get historical data for specific social media organisation page from traffic sources\nA series of historical data points showing the visits for the specified social media organisation page.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/social_media_organisations/{social_media_organisation_id}/pages/{page_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "social_media_organisation_id", "in": "path", "description": "Id for specific social media.", "required": true, "type": "string" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_summary", "desc": "Get an overview of traffic sources\nGet an overview of traffic sources", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/summary", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_summary_hist", "desc": "Get historical data for traffic sources\nGet historical data for traffic sources", "method": "get", "path": "/sites/{site_id}/analytics/traffic_sources/summary/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_feedback_surveys", "desc": "Get surveys from user feedback\nGet the surveys created for your account.", "method": "get", "path": "/sites/{site_id}/analytics/user_feedback/surveys", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_feedback_surveys_feedbacks", "desc": "Get feedbacks for specific survey from user feedback\nGet the feedbacks received for the specified survey.\n\nComments and ratings from actual users of your website gives you real user experience data, which cannot be gained from statistics alone. User comments enable you to make specific changes to your website which you know will benefit users of your site, and not just changes which you think will benefit them.", "method": "get", "path": "/sites/{site_id}/analytics/user_feedback/surveys/{survey_id}/feedbacks", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "survey_id", "in": "path", "description": "Id of a specific survey.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_feedback_surveys_feedbacks_hist", "desc": "Get historical data for specific survey from user feedback\nA series of historical data points showing the satisfaction scores and amount of ratings, comments and views for the specified survey.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/user_feedback/surveys/{survey_id}/feedbacks/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "survey_id", "in": "path", "description": "Id of a specific survey.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_feedback_surveys_ignored_feedbacks", "desc": "Get ignored feedbacks for specific survey from user feedback\nGet the feedback that has been ignored.", "method": "get", "path": "/sites/{site_id}/analytics/user_feedback/surveys/{survey_id}/ignored_feedbacks", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "survey_id", "in": "path", "description": "Id of a specific survey.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_feedback_surveys_pages_with_feedback", "desc": "Get pages with feedback for specific survey from user feedback\nGet the pages that have received feedback..", "method": "get", "path": "/sites/{site_id}/analytics/user_feedback/surveys/{survey_id}/pages_with_feedback", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "survey_id", "in": "path", "description": "Id of a specific survey.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "analytics_feedback_surveys_pages_with_fe_b5cyi0", "desc": "Get ratings for specific survey page with feedback from user feedback\nGet the feedbacks received for the specified survey at the specified page.\n\nComments and ratings from actual users of your website gives you real user experience data, which cannot be gained from statistics alone. User comments enable you to make specific changes to your website which you know will benefit users of your site, and not just changes which you think will benefit them.", "method": "get", "path": "/sites/{site_id}/analytics/user_feedback/surveys/{survey_id}/pages_with_feedback/{page_id}/ratings", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "survey_id", "in": "path", "description": "Id of a specific survey.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_feedback_surveys_pages_with_fe_j6zg29", "desc": "Get historical rating data for specific survey page with feedback from user feedback\nA series of historical data points showing the amount of ratings for the specified survey on the specified page.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/user_feedback/surveys/{survey_id}/pages_with_feedback/{page_id}/ratings/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "survey_id", "in": "path", "description": "Id of a specific survey.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "string", "format": "uint64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_visitors_browsers", "desc": "Get browsers from visitors\nGet the browsers used by your visitors.", "method": "get", "path": "/sites/{site_id}/analytics/visitors/browsers", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_visitors_browsers_browser_name_futqql", "desc": "Get versions for specific browser from visitors\nGet the versions of the specified browsers that have been used to visit your site.", "method": "get", "path": "/sites/{site_id}/analytics/visitors/browsers/browser_names/{browser_name}/versions", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "browser_name", "in": "path", "description": "Name of specific browser (ie. \"Chrome\", \"Firefox\" etc)", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_visitors_browsers_browser_name_r2dmtg", "desc": "Get historical data for a specific browsers versions from visitors\nA series of historical data points showing the amount of visits for a series of versions of the specified browser.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/visitors/browsers/browser_names/{browser_name}/versions/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "browser_name", "in": "path", "description": "Name of specific browser (ie. \"Chrome\", \"Firefox\" etc)", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_visitors_browsers_hist", "desc": "Get historical data for browsers from visitors\nA series of historical data points showing the amount of visits for a series of browsers.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/visitors/browsers/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_visitors_countries", "desc": "Get countries from visitors\nOverview of where visitors come from divided by country.", "method": "get", "path": "/sites/{site_id}/analytics/visitors/countries", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_visitors_countries_regions", "desc": "Get regions of countries from visitors\nOverview of where visitors come from divided by region per country.", "method": "get", "path": "/sites/{site_id}/analytics/visitors/countries/{country_id}/regions", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "country_id", "in": "path", "description": "Id for specific country.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_visitors_countries_regions_cities", "desc": "Get cities of regions of countries from visitors\nOverview of where visitors come from divided by city per region per country.", "method": "get", "path": "/sites/{site_id}/analytics/visitors/countries/{country_id}/regions/{region_id}/cities", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "country_id", "in": "path", "description": "Id for specific country.", "required": true, "type": "string" }, { "name": "region_id", "in": "path", "description": "Id for specific region.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_visitors_devices", "desc": "Get devices from visitors\nSee which type of device is being utilised the most. The category \"Desktop\" includes other devices such as gaming consoles and smart TV.", "method": "get", "path": "/sites/{site_id}/analytics/visitors/devices", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_visitors_devices_hist", "desc": "Get historical data for devices from visitors\nA series of historical data points showing the devices from visitors.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.\n", "method": "get", "path": "/sites/{site_id}/analytics/visitors/devices/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_visitors_os", "desc": "Get operating systems from visitors\nA full list of the operating systems that visitors are using.", "method": "get", "path": "/sites/{site_id}/analytics/visitors/operating_systems", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_visitors_os_hist", "desc": "Get historical data for operating systems from visitors\nA series of historical data points showing the operating sytems from visitors.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/visitors/operating_systems/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_visitors_os_os_families_versions", "desc": "Get versions of operating systems from visitors\nGets a version breakdown of a operating system.", "method": "get", "path": "/sites/{site_id}/analytics/visitors/operating_systems/os_families/{os_family}/versions", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "os_family", "in": "path", "description": "Name of specific OS (ie. \"Windows\", \"iOS\" etc)", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_visitors_os_os_families_versions_hist", "desc": "Get historical data for a specific OS's versions from visitors\nA series of historical data points showing the amount of visits for a series of versions of the specified OS.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/analytics/visitors/operating_systems/os_families/{os_family}/versions/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "os_family", "in": "path", "description": "Name of specific OS (ie. \"Windows\", \"iOS\" etc)", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_visitors_orgs", "desc": "Get organisations from visitors\nGet a list of visiting organisations, identified through IP address.", "method": "get", "path": "/sites/{site_id}/analytics/visitors/organisations", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "analytics_visitors_orgs_ip_addresses", "desc": "Get a list IP addresses for a specific organisation from visitors\nGet the IP addresses identified as belonging to a specific organisation from visitors.", "method": "get", "path": "/sites/{site_id}/analytics/visitors/organisations/{organisation_id}/ip_addresses", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "organisation_id", "in": "path", "description": "Id for specific organisation.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_visitors_orgs_pages", "desc": "Get the pages visited by a specific organisation from visitors\nAll pages visited by a specific organisation.", "method": "get", "path": "/sites/{site_id}/analytics/visitors/organisations/{organisation_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "organisation_id", "in": "path", "description": "Id for specific organisation.", "required": true, "type": "string" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "analytics_visitors_screen_resolutions", "desc": "Get screen resolutions from visitors\nGet a list of screen resolutions that visitors are using.", "method": "get", "path": "/sites/{site_id}/analytics/visitors/screen_resolutions", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "filter_id", "in": "query", "description": "Id for specific filter.", "required": false, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "string", "format": "uint64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "content_check_page", "desc": "Get check status for a page via Url\nGet check status for a page specified by Url.", "method": "get", "path": "/sites/{site_id}/content/check/page", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "url", "in": "query", "description": "Url of the site", "required": true, "type": "string" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "post_content_check_page", "desc": "Post a page check request via Url\nPOST a page check request via Url.", "method": "post", "path": "/sites/{site_id}/content/check/page", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "url", "in": "query", "description": "Url of the site", "required": true, "type": "string" } ] }, { "name": "content_check_page_", "desc": "Get check status for a page via page id\nGet check status for a page via page id.", "method": "get", "path": "/sites/{site_id}/content/check/page/{page_id}", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "post_content_check_page_", "desc": "Post a page check request via page id\nPOST a page check request via page id.", "method": "post", "path": "/sites/{site_id}/content/check/page/{page_id}", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "integer", "format": "int64" } ] }, { "name": "content_crawl", "desc": "Get crawl status for a site\nGet info about the crawl status for a site.", "method": "get", "path": "/sites/{site_id}/content/crawl", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "post_content_crawl", "desc": "Request a crawl for the site\nPOST a crawl request for the site.", "method": "post", "path": "/sites/{site_id}/content/crawl", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" } ] }, { "name": "content_pages", "desc": "Get list of pages for a site\nGet list of pages for a site.", "method": "get", "path": "/sites/{site_id}/content/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" }, { "name": "url", "in": "query", "description": "Url of the site", "required": false, "type": "string" } ] }, { "name": "content_pages_", "desc": "Get page details for page\nGet page details for a page.", "method": "get", "path": "/sites/{site_id}/content/pages/{page_id}", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "content_pages_unpublish_impact", "desc": "Get unpublishing impact for a page\nGet all information for this page that will be impacted in case of unpublishing it.", "method": "get", "path": "/sites/{site_id}/content/pages/{page_id}/unpublish_impact", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "integer", "format": "int64" } ] }, { "name": "dci_hist", "desc": "Get history.\nGet history endpoints for Dci, Seo, Accessibility and Qa-Score", "method": "get", "path": "/sites/{site_id}/dci/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "dci_overview", "desc": "Get DCI scores\nGet all DCI scores associated with this site. The DCI Score will be the score presented in the tool today.", "method": "get", "path": "/sites/{site_id}/dci/overview", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "policy_hist", "desc": "Get history of total matches across a site\nTotal amount of matches for all policies on a given site.", "method": "get", "path": "/sites/{site_id}/policy/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "policy_links_ref_docs", "desc": "Get referring documents for specific match in policies\nDocuments that refer to the resource being matched by this policy.", "method": "get", "path": "/sites/{site_id}/policy/links/{link_id}/referring_documents", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "link_id", "in": "path", "description": "Id of a specific link/URL.", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "policy_links_ref_media", "desc": "Get referring media for specific match in policies\nMedia that refer to the resource being matched by this policy.", "method": "get", "path": "/sites/{site_id}/policy/links/{link_id}/referring_media", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "link_id", "in": "path", "description": "Id of a specific link/URL.", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "policy_links_ref_pages", "desc": "Get referring pages for specific match in policies\nPages that refer to the resource being matched by this policy.", "method": "get", "path": "/sites/{site_id}/policy/links/{link_id}/referring_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "link_id", "in": "path", "description": "Id of a specific link/URL.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "policy_matches_content", "desc": "Get content matched by any policy\nAll content on the site which is matched by one or more policies.", "method": "get", "path": "/sites/{site_id}/policy/matches/content", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "policy_matches_details_links_ref_pages", "desc": "Referring pages to item matched by specific policy\nAll pages that refer to the item that is matched by this specific policy.", "method": "get", "path": "/sites/{site_id}/policy/matches/details/links/{link_id}/referring_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "link_id", "in": "path", "description": "Id of a specific link/URL.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "policy_matches_details_matches_matching__qf79ot", "desc": "Matching policies to item matched by specific policy\nAll policies that matches the item that is matched by this specific policy.", "method": "get", "path": "/sites/{site_id}/policy/matches/details/matches/{match_id}/matching_policies", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "match_id", "in": "path", "description": "Id of the match.", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "policy_pages_matching_policies", "desc": "Get policy matches for page in policies\nAll policies that match this specific page.", "method": "get", "path": "/sites/{site_id}/policy/pages/{page_id}/matching_policies", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "policy_policies", "desc": "Get policies\nAn overview of all policies that have been setup and any current matches.", "method": "get", "path": "/sites/{site_id}/policy/policies", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "policy_policies_content", "desc": "Get content matched by policy\nGet a list of all content (pages) on the site that is matched by this specific policy.", "method": "get", "path": "/sites/{site_id}/policy/policies/{policy_id}/content", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "policy_id", "in": "path", "description": "Id of the policy.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "policy_policies_docs", "desc": "Get documents matched by policy\nGet a list of all documents on the site that is matched by this specific policy.", "method": "get", "path": "/sites/{site_id}/policy/policies/{policy_id}/documents", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "policy_id", "in": "path", "description": "Id of the policy.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "policy_policies_hist", "desc": "Get history of matches for this policy\nTotal amount of matches for this policy on a given site.", "method": "get", "path": "/sites/{site_id}/policy/policies/{policy_id}/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "policy_id", "in": "path", "description": "Id of the policy.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "policy_policies_media", "desc": "Get media matched by policy\nGet a list of all media on the site that is matched by this specific policy.", "method": "get", "path": "/sites/{site_id}/policy/policies/{policy_id}/media", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "policy_id", "in": "path", "description": "Id of the policy.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_inventory_capture_tags", "desc": "Get capture tags from inventory\nAll capture tags and the pages on which they have been detected", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/capture_tags", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_inventory_capture_tags_occurrences", "desc": "Get capture tags occurrences from inventory\nThe occurrences of a specific capture tag.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/capture_tags/{tag_name_id}/occurrences", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "tag_name_id", "in": "path", "description": "Id for specific tag.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_inventory_capture_tags_values_pages", "desc": "Get capture tags occurrences' pages from inventory\nThe pages for a specific capture tag occurence.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/capture_tags/{tag_name_id}/values/{tag_value_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "tag_name_id", "in": "path", "description": "Id for specific tag.", "required": true, "type": "integer", "format": "int64" }, { "name": "tag_value_id", "in": "path", "description": "Id for specific tag value.", "required": true, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_inventory_css", "desc": "Get css assets from inventory\nAll linked CSS assets and the pages on which they have been detected on the site.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/css", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_inventory_css_pages_with_css", "desc": "Get pages with css from css inventory\nAll pages with the detected phone number.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/css/{css_id}/pages_with_css", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "css_id", "in": "path", "description": "Id of the CSS file", "required": true, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_inventory_css_pages_without_css", "desc": "Get pages without css from css inventory\nAll pages with the detected phone number.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/css/{css_id}/pages_without_css", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "css_id", "in": "path", "description": "Id of the CSS file", "required": true, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_inventory_docs", "desc": "Get documents from inventory\nA full list of all detected documents.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/documents", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "qa_inventory_email_addresses", "desc": "Get email addresses from inventory\nAll email addresses that have been detected on the site.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/email_addresses", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_inventory_email_addresses_pages", "desc": "Get pages with email from inventory\nAll pages with the detected phone number.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/email_addresses/{email_address_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "email_address_id", "in": "path", "description": "Id for specific email address.", "required": true, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_inventory_hist", "desc": "Get history from inventory\nInventory history with the total count after each crawl.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_inventory_link_texts", "desc": "Get link texts from inventory\nText used in relation to links.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/link_texts", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_inventory_link_texts_pages", "desc": "Get pages with link text from inventory\nAll pages with the link text.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/link_texts/{text_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "text_id", "in": "path", "description": "Id for specific (link) text.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_inventory_links", "desc": "Get links from inventory\nAll links detected on the site.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/links", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_inventory_links_docs", "desc": "Get documents with link\nAll documents containing this particular link.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/links/{link_id}/documents", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "link_id", "in": "path", "description": "Id of a specific link/URL.", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_inventory_links_pages", "desc": "Get pages with link\nAll pages with the detected link.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/links/{link_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "link_id", "in": "path", "description": "Id of a specific link/URL.", "required": true, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_inventory_media", "desc": "Get media files from inventory\nAll media files on the site.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/media", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_inventory_meta_tags", "desc": "Get meta tags from inventory\nAll meta tags found anywhere on the site.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/meta_tags", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_inventory_meta_tags_contents", "desc": "Get meta tag contents\nAll occurrences of the specific meta tag.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/meta_tags/{meta_name_id}/contents", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "meta_name_id", "in": "path", "description": "Id for specific meta name.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_inventory_meta_tags_contents_pages", "desc": "Get meta tag pages\nAll pages with the detected phone number", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/meta_tags/{meta_name_id}/contents/{meta_content_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "meta_name_id", "in": "path", "description": "Id for specific meta name.", "required": true, "type": "integer", "format": "int64" }, { "name": "meta_content_id", "in": "path", "description": "Id for specific meta content.", "required": true, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_inventory_pages", "desc": "Get pages from inventory\nHTML pages with referring page information and the date each page was first detected.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" }, { "name": "url", "in": "query", "description": "Url of the site", "required": false, "type": "string" } ] }, { "name": "qa_inventory_pages_ref_pages", "desc": "Get referring pages for page in inventory\nAll referring pages to this specific page.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/pages/{page_id}/referring_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_inventory_personal_id_numbers", "desc": "Get personal id numbers from inventory\nDuring the crawl a check is made for identification numbers relating to where the account is located. For example, for US accounts we will look for Social Security numbers. All potential identification numbers that may have been accidentally published on the website are collected.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/personal_id_numbers", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_inventory_personal_id_numbers_docs", "desc": "Get documents with personal id numbers from inventory\nAll documents containing this specific personal id number.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/personal_id_numbers/{personal_id_number_id}/documents", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "personal_id_number_id", "in": "path", "description": "Id for specific personal id.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_inventory_personal_id_numbers_pages", "desc": "Get pages with personal id numbers from inventory\nAll pages containing this specific personal id number.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/personal_id_numbers/{personal_id_number_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "personal_id_number_id", "in": "path", "description": "Id for specific personal id.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_inventory_phone_numbers", "desc": "Get phone numbers from inventory\nPhone numbers and the pages on which they have been detected - useful when numbers need to be updated or removed from the site.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/phone_numbers", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_inventory_phone_numbers_pages", "desc": "Get pages with phone number from inventory\nAll pages with the detected phone number", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/phone_numbers/{phone_number_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "phone_number_id", "in": "path", "description": "Id for specific phone number.", "required": true, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_inventory_scripts", "desc": "Get java scripts from inventory\nJavaScript files and the pages on which they have been detected – especially useful if specific scripts should be present on all pages.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/scripts", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_inventory_scripts_pages_with_script", "desc": "Get pages with java script from inventory\nAll pages with the specific JavaScript file.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/scripts/{script_id}/pages_with_script", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "script_id", "in": "path", "description": "Id for specific script.", "required": true, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_inventory_scripts_pages_without_script", "desc": "Get pages without java script from inventory\nAll pages without this specific JavaScript file.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/scripts/{script_id}/pages_without_script", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "script_id", "in": "path", "description": "Id for specific script.", "required": true, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_inventory_trademarks_pages", "desc": "Get pages with trademark from inventory\nAll pages containing this specific trademark.", "method": "get", "path": "/sites/{site_id}/quality_assurance/inventory/trademarks/{trademark_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "trademark_id", "in": "path", "description": "Id for specific trademark.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_links_broken_links", "desc": "Get broken links\nAll unique links that are broken, and the pages where they are located - Broken links can detrimentally affect the user experience of your visitors.", "method": "get", "path": "/sites/{site_id}/quality_assurance/links/broken_links", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_links_broken_links_in_docs", "desc": "Get broken links in documents\nAll unique links that are broken, and the pages where they are located - Broken links can detrimentally affect the user experience of your visitors.", "method": "get", "path": "/sites/{site_id}/quality_assurance/links/broken_links_in_documents", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_links_broken_links_in_docs_docs", "desc": "Get documents with broken link\nGet all the documents that contains this specific broken link.", "method": "get", "path": "/sites/{site_id}/quality_assurance/links/broken_links_in_documents/{link_id}/documents", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "link_id", "in": "path", "description": "Id of a specific link/URL.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_links_broken_links_pages", "desc": "Get pages with broken link\nAll pages containing this specific broken link.", "method": "get", "path": "/sites/{site_id}/quality_assurance/links/broken_links/{link_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "link_id", "in": "path", "description": "Id of a specific link/URL.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_links_dismissed_links", "desc": "Get dismissed links\nDismissed links will not be taken in consideration as broken link and no longer affect your DCI score.\n\nInclude also links that have been ignored – errors with these links will no longer be highlighted within QA.\n", "method": "get", "path": "/sites/{site_id}/quality_assurance/links/dismissed_links", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_links_docs_with_broken_links", "desc": "Get documents with broken links\nAll PDFs where broken links have been found - Broken links detrimentally affect the user experience for your visitors.", "method": "get", "path": "/sites/{site_id}/quality_assurance/links/documents_with_broken_links", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "qa_links_docs_with_broken_links_broken_links", "desc": "Get all broken links in document\nGet all broken links in the specific document.", "method": "get", "path": "/sites/{site_id}/quality_assurance/links/documents_with_broken_links/{document_id}/broken_links", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "document_id", "in": "path", "description": "Id for specific document.", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_links_docs_with_broken_links_pages", "desc": "Get pages with broken links\nAll pages where broken links have been found - Broken links detrimentally affect the user experience for your visitors.", "method": "get", "path": "/sites/{site_id}/quality_assurance/links/documents_with_broken_links/{document_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "document_id", "in": "path", "description": "Id for specific document.", "required": true, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_links_hist", "desc": "Get historical data for links\nA series of historical data points showing the link status (pages with broken links, etc) over the selected period.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/quality_assurance/links/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_links_ignored_links", "desc": "Get ignored links\nLinks that have been ignored – errors with these links will no longer be highlighted within QA.\n\nNoe", "method": "get", "path": "/sites/{site_id}/quality_assurance/links/ignored_links", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_links_pages_with_broken_links", "desc": "Get pages with broken links\nAll pages containing this specific broken link.", "method": "get", "path": "/sites/{site_id}/quality_assurance/links/pages_with_broken_links", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "qa_links_pages_with_broken_links_broken_links", "desc": "Get broken links from page with broken links\nAll broken links from this specific page containing broken links.", "method": "get", "path": "/sites/{site_id}/quality_assurance/links/pages_with_broken_links/{page_id}/broken_links", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_links_unsafe_domains", "desc": "Get links to unsafe domains\nLinks to unsafe domains.\n\nDomains that have been identified as potentially risky by Google's Safe Browsing API. An advisory is provided by Google in regards to Safe Browsing.\n\nIf users go to potentially risky domains through links on your site, this can reflect negatively on your site's trustworthiness.", "method": "get", "path": "/sites/{site_id}/quality_assurance/links/unsafe_domains", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_links_unsafe_domains_docs", "desc": "Get documents with unsafe domain from links\nAll documents containing with links to this unsafe domain.", "method": "get", "path": "/sites/{site_id}/quality_assurance/links/unsafe_domains/{domain_id}/documents", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "domain_id", "in": "path", "description": "Id for specific domain.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_links_unsafe_domains_pages", "desc": "Get pages with links to unsafe domain\nAll pages containing with links to this unsafe domain.", "method": "get", "path": "/sites/{site_id}/quality_assurance/links/unsafe_domains/{domain_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "domain_id", "in": "path", "description": "Id for specific domain.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_overview_check_hist", "desc": "Get check history from crawls\nFull history of all checks that have been run for the selected site.", "method": "get", "path": "/sites/{site_id}/quality_assurance/overview/check_history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_overview_check_hist_broken_links", "desc": "Get broken links from check in check history\n\nGet all broken links on pages detected at this specific check.", "method": "get", "path": "/sites/{site_id}/quality_assurance/overview/check_history/{history_id}/broken_links", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "history_id", "in": "path", "description": "Id for specific history point - Ie. a specific point in time where checks where run for the site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_overview_check_hist_broken_links_in_docs", "desc": "Get broken links in documents from check history\nGet all broken links in documents detected at this specific check.", "method": "get", "path": "/sites/{site_id}/quality_assurance/overview/check_history/{history_id}/broken_links_in_documents", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "history_id", "in": "path", "description": "Id for specific history point - Ie. a specific point in time where checks where run for the site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_overview_check_hist_known_links", "desc": "Get known links from check in check history\nGet all known links on pages detected at this specific check.", "method": "get", "path": "/sites/{site_id}/quality_assurance/overview/check_history/{history_id}/known_links", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "history_id", "in": "path", "description": "Id for specific history point - Ie. a specific point in time where checks where run for the site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_overview_check_hist_known_pages", "desc": "Get known pages from check in check history\nGet all known pages visited at this specific check.", "method": "get", "path": "/sites/{site_id}/quality_assurance/overview/check_history/{history_id}/known_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "history_id", "in": "path", "description": "Id for specific history point - Ie. a specific point in time where checks where run for the site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_overview_check_hist_new_links", "desc": "Get new links from check in check history\nGet all new links visited at this specific check", "method": "get", "path": "/sites/{site_id}/quality_assurance/overview/check_history/{history_id}/new_links", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "history_id", "in": "path", "description": "Id for specific history point - Ie. a specific point in time where checks where run for the site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_overview_check_hist_new_pages", "desc": "Get new pages from check in check history\nGet all new pages visited at this specific check.", "method": "get", "path": "/sites/{site_id}/quality_assurance/overview/check_history/{history_id}/new_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "history_id", "in": "path", "description": "Id for specific history point - Ie. a specific point in time where checks where run for the site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_overview_check_hist_removed_links", "desc": "Get removed links from check in check history\nGet all former known links that were no longer present at this specific check.", "method": "get", "path": "/sites/{site_id}/quality_assurance/overview/check_history/{history_id}/removed_links", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "history_id", "in": "path", "description": "Id for specific history point - Ie. a specific point in time where checks where run for the site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_overview_check_hist_removed_pages", "desc": "Get removed pages from check in check history\nGet all former known pages that were no longer present at this specific check.", "method": "get", "path": "/sites/{site_id}/quality_assurance/overview/check_history/{history_id}/removed_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "history_id", "in": "path", "description": "Id for specific history point - Ie. a specific point in time where checks where run for the site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_overview_groups", "desc": "Get quality assurance groups\nGroups are used to display information for specific sections of the website. Only groups that are visible under your profile are displayed.", "method": "get", "path": "/sites/{site_id}/quality_assurance/overview/groups", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_overview_groups_users", "desc": "Get users from group\nGet users belonging to this specific group.", "method": "get", "path": "/sites/{site_id}/quality_assurance/overview/groups/{group_id}/users", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "path", "description": "Id for specific group.", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_overview_priority_pages", "desc": "Get priority pages\nPages with errors have a page score to enable you to target those pages where corrections will have the most positive effect for your users.", "method": "get", "path": "/sites/{site_id}/quality_assurance/overview/priority_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "qa_overview_summary", "desc": "Get summary for quality assurance\nGet summary of QA issues detected on the site.", "method": "get", "path": "/sites/{site_id}/quality_assurance/overview/summary", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "qa_readability_accepted_words", "desc": "Get accepted readability words\nAccepted words are words that can't be changed or words that should not be altered irrespective of length or number of syllables.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/accepted_words", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_readability_automated_readability_exc_10f5a6", "desc": "Get excluded pages for automated readability\nAll pages that have been excluded from the automated readability test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/automated_readability/excluded_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "qa_readability_automated_readability_pages", "desc": "Get readability pages for automated readability\nAll pages where a readability score has been calculated for the automated readability test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/automated_readability/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "qa_readability_automated_readability_scores", "desc": "Get readability scores for automated readability\nPages are placed into levels depending on the difficulty level of the content that relates to the reading ability of a person in full time education based on the automated readability test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/automated_readability/scores", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_readability_automated_readability_sco_g1ow3r", "desc": "Get pages with readability score for automated readability\nPages that relates to the reading ability bucket for the automated readability test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/automated_readability/scores/{bucket_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "bucket_id", "in": "path", "description": "Id of the readability bucket.", "required": true, "type": "integer", "format": "int32" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_readability_coleman_liau_excluded_pages", "desc": "Get excluded pages for coleman liau\nAll pages that have been excluded from the coleman liau test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/coleman_liau/excluded_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "qa_readability_coleman_liau_pages", "desc": "Get readability pages for coleman liau\nAll pages where a readability score has been calculated for the coleman liau test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/coleman_liau/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "qa_readability_coleman_liau_scores", "desc": "Get readability scores for coleman liau\nPages are placed into levels depending on the difficulty level of the content that relates to the reading ability of a person in full time education based on the coleman liau test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/coleman_liau/scores", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_readability_coleman_liau_scores_pages", "desc": "Get pages with readability score for coleman liau\nPages that relates to the reading ability bucket for coleman liau.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/coleman_liau/scores/{bucket_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "bucket_id", "in": "path", "description": "Id of the readability bucket.", "required": true, "type": "integer", "format": "int32" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_readability_flesch_k_grade_level_excl_lxl753", "desc": "Get excluded pages for flesch kincaid grade level\nAll pages that have been excluded from the flesch kincaid grade level test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/flesch_kincaid_grade_level/excluded_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "qa_readability_flesch_k_grade_level_pages", "desc": "Get readability pages for flesch kincaid grade level\nAll pages where a readability score has been calculated for the flesch kincade grade level test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/flesch_kincaid_grade_level/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "qa_readability_flesch_k_grade_level_scores", "desc": "Get readability scores for flesch kincaid grade level\nPages are placed into levels depending on the difficulty level of the content that relates to the reading ability of a person in full time education based on the flesch kincade grade level test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/flesch_kincaid_grade_level/scores", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_readability_flesch_k_grade_level_scor_ixjt26", "desc": "Get pages with readability score for flesch kincaid grade level\nPages that relates to the reading ability bucket for the flesch kincaid grade level test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/flesch_kincaid_grade_level/scores/{bucket_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "bucket_id", "in": "path", "description": "Id of the readability bucket.", "required": true, "type": "integer", "format": "int32" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_readability_flesch_k_reading_ease_exc_8vjx6s", "desc": "Get excluded pages for flesch kincaid reading ease\nAll pages that have been excluded from the flesch kincaid reading ease test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/flesch_kincaid_reading_ease/excluded_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "qa_readability_flesch_k_reading_ease_pages", "desc": "Get readability pages for flesch kincaid reading ease\nAll pages where a readability score has been calculated for the flesch kincade reading ease test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/flesch_kincaid_reading_ease/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "qa_readability_flesch_k_reading_ease_scores", "desc": "Get readability scores for flesch kincaid reading ease\nPages are placed into levels depending on the difficulty level of the content that relates to the reading ability of a person in full time education based on the flesch kincade reading ease test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/flesch_kincaid_reading_ease/scores", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_readability_flesch_k_reading_ease_sco_9gwzgd", "desc": "Get pages with readability score for flesch kincaid reading ease\nPages that relates to the reading ability bucket for the flesch kincaid reading ease test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/flesch_kincaid_reading_ease/scores/{bucket_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "bucket_id", "in": "path", "description": "Id of the readability bucket.", "required": true, "type": "integer", "format": "int32" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_readability_gunning_fog_excluded_pages", "desc": "Get excluded pages for gunning fog\nAll pages that have been excluded from the gunning fog test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/gunning_fog/excluded_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "qa_readability_gunning_fog_pages", "desc": "Get readability pages for gunning fog\nAll pages where a readability score has been calculated for the gunning fog test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/gunning_fog/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "qa_readability_gunning_fog_scores", "desc": "Get readability scores for gunning fog\nPages are placed into levels depending on the difficulty level of the content that relates to the reading ability of a person in full time education based on the gunning fog test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/gunning_fog/scores", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_readability_gunning_fog_scores_pages", "desc": "Get pages with readability score for gunning fog\nPages that relates to the reading ability bucket for the gunning fog test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/gunning_fog/scores/{bucket_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "bucket_id", "in": "path", "description": "Id of the readability bucket.", "required": true, "type": "integer", "format": "int32" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_readability_lix_excluded_pages", "desc": "Get excluded pages for lix\nAll pages that have been excluded from the lix test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/lix/excluded_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "qa_readability_lix_pages", "desc": "Get readability pages for lix\nAll pages where a readability score has been calculated for the lix test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/lix/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "qa_readability_lix_scores", "desc": "Get readability scores for lix\nPages are placed into levels depending on the difficulty level of the content that relates to the reading ability of a person in full time education based on the lix test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/lix/scores", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_readability_lix_scores_pages", "desc": "Get pages with readability score for lix\nPages that relates to the reading ability bucket for the lix test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/lix/scores/{bucket_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "bucket_id", "in": "path", "description": "Id of the readability bucket.", "required": true, "type": "integer", "format": "int32" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_readability_smog_excluded_pages", "desc": "Get excluded pages for smog\nAll pages that have been excluded from the smog test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/smog/excluded_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "qa_readability_smog_pages", "desc": "Get readability pages for smog\nAll pages where a readability score has been calculated for the smog test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/smog/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "qa_readability_smog_scores", "desc": "Get readability scores for smog\nPages are placed into levels depending on the difficulty level of the content that relates to the reading ability of a person in full time education based on the smog test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/smog/scores", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_readability_smog_scores_pages", "desc": "Get pages with readability score for smog\nPages that relates to the reading ability bucket for the smog test.", "method": "get", "path": "/sites/{site_id}/quality_assurance/readability/tests/smog/scores/{bucket_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "bucket_id", "in": "path", "description": "Id of the readability bucket.", "required": true, "type": "integer", "format": "int32" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_spelling_approved_words", "desc": "Get approved words from spelling\nWords that we have found and that has been accepted by users.", "method": "get", "path": "/sites/{site_id}/quality_assurance/spelling/approved_words", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_spelling_approved_words_pages", "desc": "Get pages with approved words from spelling\nGet pages containing this specific word that has been approved by a user.", "method": "get", "path": "/sites/{site_id}/quality_assurance/spelling/approved_words/{word_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "word_id", "in": "path", "description": "Id for specific word.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_spelling_hist", "desc": "Get historical data for spelling\nA series of historical data points showing the status of misspellings and potential misspellings over the selected period.\n\nWhen viewing historical data the resolution of the data points will be dependent on the period specified. For single-day periods the resolution will be hours. For periods less than 62 days (approximately two months) the resolution will be days. For longer periods the resolution will be months.", "method": "get", "path": "/sites/{site_id}/quality_assurance/spelling/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_spelling_languages", "desc": "Get languages from spelling\nAll languages detected on the site and the percentage of content written in each language, both at site and page level.", "method": "get", "path": "/sites/{site_id}/quality_assurance/spelling/languages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_spelling_languages_pages", "desc": "Get pages with language from spelling\nGet pages written in this specific language.", "method": "get", "path": "/sites/{site_id}/quality_assurance/spelling/languages/{language_code}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "language_code", "in": "path", "description": "Language code for specific country (ie. \"en\", \"de\" etc.)", "required": true, "type": "string" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_spelling_misspellings", "desc": "Get misspellings from spelling\nWords that could not be found in the system's dictionary or words that have been confirmed as misspellings by an administrator.", "method": "get", "path": "/sites/{site_id}/quality_assurance/spelling/misspellings", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_spelling_misspellings_pages", "desc": "Get pages with misspelling from spelling\nGet pages containing this specific misspelling.", "method": "get", "path": "/sites/{site_id}/quality_assurance/spelling/misspellings/{word_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "word_id", "in": "path", "description": "Id for specific word.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_spelling_pages", "desc": "Get pages from spelling\nAll pages where either misspellings or potential misspellings have been detected. Misspellings are confirmed as errors where potential misspellings need to be reviewed.", "method": "get", "path": "/sites/{site_id}/quality_assurance/spelling/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "qa_spelling_pages_misspellings", "desc": "Get misspellings for a page from spelling\nGet misspellings for this specific page.", "method": "get", "path": "/sites/{site_id}/quality_assurance/spelling/pages/{page_id}/misspellings", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_spelling_pages_potential_misspellings", "desc": "Get potential misspelling for a page from spelling\nThis endpoint is deprecated. Get potential misspellings for this specific page", "method": "get", "path": "/sites/{site_id}/quality_assurance/spelling/pages/{page_id}/potential_misspellings", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_spelling_pages_words_to_review", "desc": "Get words to review for a page from spelling\nGet words to review for this specific page.", "method": "get", "path": "/sites/{site_id}/quality_assurance/spelling/pages/{page_id}/words_to_review", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_spelling_potential_misspellings", "desc": "Get potential misspellings from spelling\nThis endpoint is deprecated. Potential misspellings are words on the site, which are not found in the dictionary, and have not been automatically confirmed as misspellings by the Quality Assurance service.", "method": "get", "path": "/sites/{site_id}/quality_assurance/spelling/potential_misspellings", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_spelling_potential_misspellings_pages", "desc": "Get pages with potential misspelling from spelling\nThis endpoint is deprecated. Get pages containing this specific potential misspelling.", "method": "get", "path": "/sites/{site_id}/quality_assurance/spelling/potential_misspellings/{word_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "word_id", "in": "path", "description": "Id for specific word.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "qa_spelling_words_to_review", "desc": "Get words to review from spelling\nWords to review are words on the site, which are not found in the dictionary, and have not been automatically confirmed as misspellings by the Quality Assurance service.", "method": "get", "path": "/sites/{site_id}/quality_assurance/spelling/words_to_review", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "qa_spelling_words_to_review_pages", "desc": "Get pages with words to review from spelling\nGet pages containing this specific word to review.\n\n", "method": "get", "path": "/sites/{site_id}/quality_assurance/spelling/words_to_review/{word_id}/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "word_id", "in": "path", "description": "Id for specific word.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues", "desc": "Get issues\nGet all SEO issues on your website", "method": "get", "path": "/sites/{site_id}/seov2/issues", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "category", "in": "query", "description": "The category filter", "required": false, "type": "string", "enum": [ "none", "technical", "content", "ux", "mobile" ], "default": "none" }, { "name": "complexity", "in": "query", "description": "The complexity filter", "required": false, "type": "string", "enum": [ "none", "low", "medium", "high", "extreme" ], "default": "none" }, { "name": "fixed", "in": "query", "description": "The fixed filter", "required": false, "type": "boolean" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_broken_links", "desc": "Get broken links\nGet the broken links from issues", "method": "get", "path": "/sites/{site_id}/seov2/issues/broken_links", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_broken_links_entry_pages", "desc": "Get broken links on entry pages\nGet broken links on entry pages for your website", "method": "get", "path": "/sites/{site_id}/seov2/issues/broken_links_entry_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_broken_links_entry_pages_details", "desc": "Get overall broken links stats for entry pages\nGet overall broken links stats for entry pages", "method": "get", "path": "/sites/{site_id}/seov2/issues/broken_links_entry_pages/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_broken_links_entry_pages_hist", "desc": "Get the occurrences of broken links on entry pages historically\nGet the occurrences of broken links on entry pages historically", "method": "get", "path": "/sites/{site_id}/seov2/issues/broken_links_entry_pages/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_broken_links_details", "desc": "Get overall broken links stats\nGet the overall broken links stats for your website", "method": "get", "path": "/sites/{site_id}/seov2/issues/broken_links/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_broken_links_hist", "desc": "Get the occurrences of broken links historically\nGet the occurrences of broken links historically", "method": "get", "path": "/sites/{site_id}/seov2/issues/broken_links/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_canonical_urls", "desc": "Get pages not linking to the canonical page\nGet pages not linking to the canonical page", "method": "get", "path": "/sites/{site_id}/seov2/issues/canonical_urls", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_canonical_urls_details", "desc": "Get overall stats for canonical issue\nGet overall stats for canonical issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/canonical_urls/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_canonical_urls_hist", "desc": "Get historical occurrences of canonical issue\nGet historical occurrences of canonical issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/canonical_urls/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_code_text_ratio", "desc": "Get pages for code to text ratio issue\nPages with text-to-code ratio below 30%", "method": "get", "path": "/sites/{site_id}/seov2/issues/code_text_ratio", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_code_text_ratio_details", "desc": "Get overall stats of code to text ratio issue\nGet overall stats of code to text ratio issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/code_text_ratio/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_code_text_ratio_hist", "desc": "Get historical occurrences of code to text ratio issue\nGet historical occurrences of code to text ratio issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/code_text_ratio/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_compression_used_details", "desc": "Get compression used issue\nGet compression used issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/compression_used/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_correct_404s", "desc": "Get links for the correct 404 issue\nLinks should return correctly 404 when it's a 404 and not be a \"soft\" 404.", "method": "get", "path": "/sites/{site_id}/seov2/issues/correct_404s", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_correct_404s_details", "desc": "Get overall stats for the correct 404 issue\nGet overall stats for the correct 404 issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/correct_404s/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_correct_404s_hist", "desc": "Get historical occurrences of correct 404 issue\nGet historical occurrences of correct 404 issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/correct_404s/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_css_validation", "desc": "Get stylesheets for the css validation issue\nGet all stylesheets not passing css validation.\nThis check is deprecated from November 2019. The data is still available but won't get updated.", "method": "get", "path": "/sites/{site_id}/seov2/issues/css_validation", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_css_validation_details", "desc": "Get overall stats for the css validation issue\nGet overall stats for the css validation issue.\nThis check is deprecated from November 2019. The data is still available but won't get updated.", "method": "get", "path": "/sites/{site_id}/seov2/issues/css_validation/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_css_validation_hist", "desc": "Get historical occurrences of css validation issue\nGet historical occurrences of css validation issue.\nThis check is deprecated from November 2019. The data is still available but won't get updated.", "method": "get", "path": "/sites/{site_id}/seov2/issues/css_validation/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_dead_end_pages", "desc": "Get dead end pages issue\nGet all the pages with no internal links", "method": "get", "path": "/sites/{site_id}/seov2/issues/dead_end_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_dead_end_pages_details", "desc": "Get overall stats for the dead end pages issue\nGet overall stats for the dead end pages issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/dead_end_pages/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_dead_end_pages_hist", "desc": "Get historical occurrences of dead end pages issue\nGet historical occurrences of dead end pages issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/dead_end_pages/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_desktop_speed_details", "desc": "Get desktop speed issue\nGet desktop speed issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/desktop_speed/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_desktop_speed_hist", "desc": "Get the desktop speed score historically\nGet the desktop speed score historically", "method": "get", "path": "/sites/{site_id}/seov2/issues/desktop_speed/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_dup_description", "desc": "Get duplicate description issue\nGet all duplicate meta descriptions", "method": "get", "path": "/sites/{site_id}/seov2/issues/duplicate_description", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_dup_description_details", "desc": "Get overall stats for duplicate meta description issue\nGet overall stats for duplicate meta description issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/duplicate_description/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_dup_description_hist", "desc": "Get historical occurrences of duplicate description issue\nGet historical occurrences of duplicate meta description issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/duplicate_description/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_dup_page_title", "desc": "Get duplicate page title issue\nGet all the duplicate page titles", "method": "get", "path": "/sites/{site_id}/seov2/issues/duplicate_page_title", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_dup_page_title_details", "desc": "Get overall stats for duplicate page title issue\nGet overall stats for duplicate page title issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/duplicate_page_title/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_dup_page_title_hist", "desc": "Get historical occurrences of duplicate page title issue\nGet historical occurrences of duplicate page title issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/duplicate_page_title/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_empty_h1", "desc": "Get empty H1 issue\nGet all pages with an empty H1", "method": "get", "path": "/sites/{site_id}/seov2/issues/empty_h1", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_empty_h1_details", "desc": "Get overall stats for empty H1 issue\nGet overall stats for empty H1 issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/empty_h1/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_empty_h1_hist", "desc": "Get historical occurrences of empty H1 issue\nGet historical occurrences of empty H1 issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/empty_h1/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_fontsize_legibility_details", "desc": "Get font size legibility issue\nGet font size legibility issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/fontsize_legibility/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_html_validation", "desc": "Get html validation issue\nGet all the pages which do not pass html validation. This check is deprecated from November 2019. The data is still available but won't get updated.", "method": "get", "path": "/sites/{site_id}/seov2/issues/html_validation", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_html_validation_details", "desc": "Get overall stats for html validation issue\nGet overall stats for html validation issue.\nThis check is deprecated from November 2019. The data is still available but won't get updated.", "method": "get", "path": "/sites/{site_id}/seov2/issues/html_validation/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_html_validation_hist", "desc": "Get historical occurrences of html validation issue\nGet historical occurrences of html validation issue.\nThis check is deprecated from November 2019. The data is still available but won't get updated.", "method": "get", "path": "/sites/{site_id}/seov2/issues/html_validation/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_image_alt_attr", "desc": "Get image alt attribute issue\nGet all pages where an image is missing an alt attribute", "method": "get", "path": "/sites/{site_id}/seov2/issues/image_alt_attribute", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_image_alt_attr_details", "desc": "Get overall stats for image alt attribute issue\nGet overall stats for image alt attribute issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/image_alt_attribute/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_image_alt_attr_hist", "desc": "Get historical occurrences of image alt attribute issue\nGet historical occurrences of image alt attribute issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/image_alt_attribute/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_image_empty_alt_attr", "desc": "Get image empty alt attribute issue\nGet all pages with images that has an empty attribute", "method": "get", "path": "/sites/{site_id}/seov2/issues/image_empty_alt_attribute", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_image_empty_alt_attr_details", "desc": "Get overall stats for image empty alt attribute issue\nGet overall stats for image empty alt attribute issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/image_empty_alt_attribute/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_image_empty_alt_attr_hist", "desc": "Get historical occurrences of image empty alt attribute issue\nGet historical occurrences of image empty alt attribute issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/image_empty_alt_attribute/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_image_width_height_attr", "desc": "Get image with height attribute issue\nGet all pages with an image missing width and/or height attributes", "method": "get", "path": "/sites/{site_id}/seov2/issues/image_width_height_attribute", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_image_width_height_attr_details", "desc": "Get overall stats for image width height attribute issue\nGet overall stats for image width height attribute issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/image_width_height_attribute/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_image_width_height_attr_hist", "desc": "Get historical occurrences of image width height attribute issue\nGet historical occurrences of image width height attribute issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/image_width_height_attribute/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_images_1mb", "desc": "Get images over 1mb issue\nGet all images that are larger than 1 mb", "method": "get", "path": "/sites/{site_id}/seov2/issues/images_1mb", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_images_1mb_details", "desc": "Get overall stats for images over 1mb issue\nGet overall stats for images over 1mb issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/images_1mb/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_images_1mb_hist", "desc": "Get historical occurrences of images over 1mb issue\nGet historical occurrences of images over 1mb issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/images_1mb/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_links_to_unsafe_domains", "desc": "Get links to unsafe domains issue\nGet all links which link to a domain considered unsafe", "method": "get", "path": "/sites/{site_id}/seov2/issues/links_to_unsafe_domains", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_links_to_unsafe_domains_details", "desc": "Get overall stats for links to unsafe domains issue\nGet overall stats for links to unsafe domains issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/links_to_unsafe_domains/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_links_to_unsafe_domains_hist", "desc": "Get historical occurrences of unsafe domains issue\nGet historical occurrences of unsafe domains issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/links_to_unsafe_domains/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_load_time", "desc": "Get load time issue\nGet all pages with loading time exceeding 2 seconds", "method": "get", "path": "/sites/{site_id}/seov2/issues/load_time", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_load_time_details", "desc": "Get overall stats for load time issue\nGet overall stats for load time issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/load_time/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_load_time_hist", "desc": "Get historical occurrences of load time issue\nGet historical occurrences of load time issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/load_time/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_long_sentences", "desc": "Get long sentences issue\nGet all pages with sentences longer than 20 words.", "method": "get", "path": "/sites/{site_id}/seov2/issues/long_sentences", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_long_sentences_details", "desc": "Get overall stats for the long sentences issue\nGet overall stats for the long sentences issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/long_sentences/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_long_sentences_hist", "desc": "Get historical occurrences of long sentences issue\nGet historical occurrences of long sentences issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/long_sentences/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_long_urls", "desc": "Get long urls issue\nGet all pages with long urls ", "method": "get", "path": "/sites/{site_id}/seov2/issues/long_urls", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_long_urls_details", "desc": "Get overall stats for long urls issue\nGet overall stats for long urls issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/long_urls/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_long_urls_hist", "desc": "Get historical occurrences of long urls issue\nGet historical occurrences of long urls issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/long_urls/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_many_internal_links", "desc": "Get many internal links issue\nGet all pages with 60 or more internal links", "method": "get", "path": "/sites/{site_id}/seov2/issues/many_internal_links", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_many_internal_links_details", "desc": "Get overall stats for the many internal links issue\nGet overall stats for the many internal links issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/many_internal_links/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_many_internal_links_hist", "desc": "Get historical occurrences of many internal links issue\nGet historical occurrences of many internal links issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/many_internal_links/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_meta_desc_empty", "desc": "Get meta description empty issue\nGet all pages with an empty meta description", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_desc_empty", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_meta_desc_empty_details", "desc": "Get overall stats for meta description empty issue\nGet overall stats for meta description empty issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_desc_empty/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_meta_desc_empty_hist", "desc": "Get historical occurrences of meta description empty issue\nGet historical occurrences of meta description empty issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_desc_empty/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_meta_desc_long", "desc": "Get meta description too long issue\nGet all pages with meta descriptions that are too long", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_desc_long", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_meta_desc_long_details", "desc": "Get overall stats for meta description too long issue\nGet overall stats for meta description too long issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_desc_long/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_meta_desc_long_hist", "desc": "Get historical occurrences of meta description too long issue\nGet historical occurrences of meta description too long issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_desc_long/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_meta_desc_missing", "desc": "Get meta description empty issue\nGet all pages with a missing meta description", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_desc_missing", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_meta_desc_missing_details", "desc": "Get overall stats for meta description missing issue\nGet overall stats for meta description missing issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_desc_missing/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_meta_desc_missing_hist", "desc": "Get historical occurrences of meta description missing issue\nGet historical occurrences of meta description missing issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_desc_missing/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_meta_desc_multiple", "desc": "Get multiple meta description issue\nGet all pages with multiple meta descriptions", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_desc_multiple", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_meta_desc_multiple_details", "desc": "Get overall stats for multiple meta description issue\nGet overall stats for multiple meta description issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_desc_multiple/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_meta_desc_multiple_hist", "desc": "Get historical occurrences of multiple meta description issue\nGet historical occurrences of multiple meta description issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_desc_multiple/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_meta_desc_short", "desc": "Get meta description too short issue\nGet all pages with meta description that are too short", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_desc_short", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_meta_desc_short_details", "desc": "Get overall stats for meta description too short issue\nGet overall stats for meta description too short issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_desc_short/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_meta_desc_short_hist", "desc": "Get historical occurrences of meta description too short issue\nGet historical occurrences of meta description too short issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_desc_short/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_meta_title_empty", "desc": "Get meta title empty issue\nGet all pages with an empty meta title", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_title_empty", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_meta_title_empty_details", "desc": "Get overall stats for meta title empty issue\nGet overall stats for meta title empty issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_title_empty/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_meta_title_empty_hist", "desc": "Get historical occurrences of meta title empty issue\nGet historical occurrences of meta title empty issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_title_empty/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_meta_title_long", "desc": "Get meta title too long issue\nGet all pages with a meta title that is too long", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_title_long", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_meta_title_long_details", "desc": "Get overall stats for meta title too long issue\nGet overall stats for meta title too long issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_title_long/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_meta_title_long_hist", "desc": "Get historical occurrences of meta title too long issue\nGet historical occurrences of meta title too long issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_title_long/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_meta_title_missing", "desc": "Get meta title missing issue\nGet all pages with a missing meta title", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_title_missing", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_meta_title_missing_details", "desc": "Get overall stats for meta title missing issue\nGet overall stats for meta title missing issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_title_missing/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_meta_title_missing_hist", "desc": "Get historical occurrences of meta title missing issue\nGet historical occurrences of meta title missing issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_title_missing/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_meta_title_multiple", "desc": "Get multiple meta title issue\nGet all pages with multiple meta titles", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_title_multiple", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_meta_title_multiple_details", "desc": "Get overall stats for multiple meta title issue\nGet overall stats for multiple meta title issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_title_multiple/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_meta_title_multiple_hist", "desc": "Get historical occurrences for multiple meta title issue\nGet historical occurrences for multiple meta title issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_title_multiple/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_meta_title_short", "desc": "Get meta title too short issue\nGet all pages with meta titles that are too short", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_title_short", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_meta_title_short_details", "desc": "Get overall stats for meta title too short issue\nGet overall stats for meta title too short issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_title_short/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_meta_title_short_hist", "desc": "Get historical occurrences of meta title too short issue\nGet historical occurrences of meta title too short issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/meta_title_short/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_missing_h1", "desc": "Get missing h1 issue\nGet all pages without a h1", "method": "get", "path": "/sites/{site_id}/seov2/issues/missing_h1", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_missing_h1_details", "desc": "Get overall stats for missing h1 issue\nGet overall stats for missing h1 issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/missing_h1/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_missing_h1_hist", "desc": "Get historical occurrences of missing h1 issue\nGet historical occurrences of missing h1 issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/missing_h1/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_missing_robots_details", "desc": "Get missing robots issue\nGet missing robots issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/missing_robots/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_missing_sitemap_details", "desc": "Get missing sitemap issue\nGet missing sitemap issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/missing_sitemap/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_misspelling_entry_pages", "desc": "Get misspellings on entry pages issue\nGet all entry pages with a misspelling", "method": "get", "path": "/sites/{site_id}/seov2/issues/misspelling_entry_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_misspelling_entry_pages_details", "desc": "Get overall stats for misspellings on entry pages issue\nGet overall stats for misspellings on entry pages issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/misspelling_entry_pages/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_misspelling_entry_pages_hist", "desc": "Get historical occurrences of misspelling on entry pages issue\nGet historical occurrences of misspelling on entry pages issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/misspelling_entry_pages/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_misspellings", "desc": "Get misspellings issue\nGet all misspellings found on the website", "method": "get", "path": "/sites/{site_id}/seov2/issues/misspellings", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_misspellings_details", "desc": "Get overall stats for misspellings issue\nGet overall stats for misspellings issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/misspellings/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_misspellings_hist", "desc": "Get historical occurrences of misspelling issue\nGet historical occurrences of misspelling issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/misspellings/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_mobile_friendly_details", "desc": "Get mobile friendly issue\nGet mobile friendly issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/mobile_friendly/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_mobile_speed_details", "desc": "Get mobile speed issue\nGet mobile speed issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/mobile_speed/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_mobile_speed_hist", "desc": "Get the mobile speed score historically\nGet the mobile speed score historically", "method": "get", "path": "/sites/{site_id}/seov2/issues/mobile_speed/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_mobile_viewport_details", "desc": "Get mobile viewport issue\nGet mobile viewport issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/mobile_viewport/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_multiple_h1", "desc": "Get multiple h1 issue\nGet all pages with multiple h1s", "method": "get", "path": "/sites/{site_id}/seov2/issues/multiple_h1", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_multiple_h1_details", "desc": "Get overall stats for multiple h1 issue\nGet overall stats for multiple h1 issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/multiple_h1/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_multiple_h1_hist", "desc": "Get historical occurrences for multiple h1 issue\nGet historical occurrences for multiple h1 issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/multiple_h1/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_navigation_depth", "desc": "Get navigation depth issue\nGet all pages with high navigation depth", "method": "get", "path": "/sites/{site_id}/seov2/issues/navigation_depth", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_navigation_depth_details", "desc": "Get overall stats for navigation depth issue\nGet overall stats for navigation depth issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/navigation_depth/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_navigation_depth_hist", "desc": "Get historical occurrences of navigation depth issue\nGet historical occurrences of navigation depth issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/navigation_depth/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_new_pages_details", "desc": "Get new pages issue\nGet new pages issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/new_pages/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_new_pages_hist", "desc": "Get historical occurrences of new pages issue\nGet historical occurrences of new pages issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/new_pages/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_nofollow_pages", "desc": "Get nofollow pages issue\nGet all pages with a nofollow tag", "method": "get", "path": "/sites/{site_id}/seov2/issues/nofollow_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_nofollow_pages_details", "desc": "Get overall stats for nofollow pages issue\nGet overall stats for nofollow pages issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/nofollow_pages/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_nofollow_pages_hist", "desc": "Get historical occurrences of nofollow pages issue\nGet historical occurrences of nofollow pages issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/nofollow_pages/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_noindex_pages", "desc": "Get noindex pages\nGet all pages with a noindex tag", "method": "get", "path": "/sites/{site_id}/seov2/issues/noindex_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_noindex_pages_details", "desc": "Get overall stats for noindex pages issue\nGet overall stats for noindex pages issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/noindex_pages/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_noindex_pages_hist", "desc": "Get historical occurrences of noindex pages issue\nGet historical occurrences of noindex pages issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/noindex_pages/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_open_graph_tag_pages", "desc": "Get open graph tag pages issue\nGet all pages without open graph tags", "method": "get", "path": "/sites/{site_id}/seov2/issues/open_graph_tag_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_open_graph_tag_pages_details", "desc": "Get overall stats for open graph tag pages issue\nGet overall stats for open graph tag pages issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/open_graph_tag_pages/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_open_graph_tag_pages_hist", "desc": "Get historical occurrences of open graph tag pages issue\nGet historical occurrences of open graph tag pages issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/open_graph_tag_pages/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_page_size", "desc": "Get page size issue\nGet all pages with a size over 1 mb", "method": "get", "path": "/sites/{site_id}/seov2/issues/page_size", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_page_size_details", "desc": "Get overall stats for page size issue\nGet overall stats for page size issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/page_size/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_page_size_hist", "desc": "Get historical occurrences of page size issue\nGet historical occurrences of page size issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/page_size/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_pages_with_broken_links", "desc": "Get pages with broken links issue\nGet all pages with a broken link", "method": "get", "path": "/sites/{site_id}/seov2/issues/pages_with_broken_links", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_pages_with_broken_links_details", "desc": "Get overall stats for pages with broken links issue\nGet overall stats for pages with broken links issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/pages_with_broken_links/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_pages_with_broken_links_hist", "desc": "Get historical occurrences of page with broken links issue\nGet historical occurrences of page with broken links issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/pages_with_broken_links/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_pages_with_frames", "desc": "Get pages with frames issue\nGet all pages with a frame or iframe", "method": "get", "path": "/sites/{site_id}/seov2/issues/pages_with_frames", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_pages_with_frames_details", "desc": "Get overall stats for pages with frames issue\nGet overall stats for pages with frames issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/pages_with_frames/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_pages_with_frames_hist", "desc": "Get historical occurrences of page with frames issue\nGet historical occurrences of page with frames issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/pages_with_frames/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_pages_with_images_1mb", "desc": "Get pages with images over 1mb issue\nGet all pages with an image over 1 mb", "method": "get", "path": "/sites/{site_id}/seov2/issues/pages_with_images_1mb", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_pages_with_images_1mb_details", "desc": "Get overall stats for pages with images over 1mb issue\nGet overall stats for pages with images over 1mb issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/pages_with_images_1mb/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_pages_with_images_1mb_hist", "desc": "Get historical occurrences of page with images over 1mb issue\nGet historical occurrences of page with images over 1mb issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/pages_with_images_1mb/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_pages_with_misspellings", "desc": "Get pages with misspellings issue\nGet all pages with a misspelling", "method": "get", "path": "/sites/{site_id}/seov2/issues/pages_with_misspellings", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_pages_with_misspellings_details", "desc": "Get overall stats for pages with misspellings issue\nGet overall stats for pages with misspellings issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/pages_with_misspellings/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_pages_with_misspellings_hist", "desc": "Get historical occurrences of page with misspellings issue\nGet historical occurrences of page with misspellings issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/pages_with_misspellings/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_parameterized_urls", "desc": "Get parameterized urls issue\nGet all pages with a parameterized url", "method": "get", "path": "/sites/{site_id}/seov2/issues/parameterized_urls", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_parameterized_urls_details", "desc": "Get overall stats for parameterized urls issue\nGet overall stats for parameterized urls issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/parameterized_urls/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_parameterized_urls_hist", "desc": "Get historical occurrences of parameterized urls issue\nGet historical occurrences of parameterized urls issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/parameterized_urls/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_readability_pages_score", "desc": "Get readability pages score issue\nGet all pages with a readability score less than 70", "method": "get", "path": "/sites/{site_id}/seov2/issues/readability_pages_score", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_readability_pages_score_details", "desc": "Get overall stats for readability page score issue\nGet overall stats for readability page score issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/readability_pages_score/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_readability_pages_score_hist", "desc": "Get historical occurrences of readability pages score issue\nGet historical occurrences of readability pages score issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/readability_pages_score/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_redirect_301", "desc": "Get redirect 301 issue\nGet all pages with a 301 redirect", "method": "get", "path": "/sites/{site_id}/seov2/issues/redirect_301", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_redirect_301_details", "desc": "Get overall stats for redirect 301 issue\nGet overall stats for redirect 301 issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/redirect_301/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_redirect_301_hist", "desc": "Get historical occurrences of redirect 301 issue\nGet historical occurrences of redirect 301 issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/redirect_301/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_redirect_chain", "desc": "Get redirect chain issue\nGet all pages with a redirect chain", "method": "get", "path": "/sites/{site_id}/seov2/issues/redirect_chain", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_redirect_chain_details", "desc": "Get overall stats for redirect chain issue\nGet overall stats for redirect chain issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/redirect_chain/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_redirect_chain_hist", "desc": "Get historical occurrences of redirect chain issue\nGet historical occurrences of redirect chain issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/redirect_chain/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_redirect_mixed", "desc": "Get redirect mixed issue\nGet all redirect mixed pages", "method": "get", "path": "/sites/{site_id}/seov2/issues/redirect_mixed", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_redirect_mixed_details", "desc": "Get overall stats for redirect mixed issue\nGet overall stats for redirect mixed issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/redirect_mixed/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_redirect_mixed_hist", "desc": "Get historical occurrences of redirect mixed issue\nGet historical occurrences of redirect mixed issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/redirect_mixed/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_redirect_not_301", "desc": "Get redirect not 301 issue\nGet all pages with a redirect that is not 301", "method": "get", "path": "/sites/{site_id}/seov2/issues/redirect_not_301", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_redirect_not_301_details", "desc": "Get overall stats for redirect not 301 issue\nGet overall stats for redirect not 301 issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/redirect_not_301/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_redirect_not_301_hist", "desc": "Get historical occurrences of redirect not 301 issue\nGet historical occurrences of redirect not 301 issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/redirect_not_301/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_sitemap_excluded_pages", "desc": "Get sitemap excluded pages issue\n\nGet all pages not included in the sitemap", "method": "get", "path": "/sites/{site_id}/seov2/issues/sitemap_excluded_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_sitemap_excluded_pages_details", "desc": "Get overall stats for sitemap excluded pages issue\nGet overall stats for sitemap excluded pages issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/sitemap_excluded_pages/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_sitemap_excluded_pages_hist", "desc": "Get historical occurrences of sitemap excluded pages issue\nGet historical occurrences of sitemap excluded pages issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/sitemap_excluded_pages/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_ssl_enabled", "desc": "Get ssl enabled issue\nGet all pages without ssl", "method": "get", "path": "/sites/{site_id}/seov2/issues/ssl_enabled", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_ssl_enabled_details", "desc": "Get overall stats for ssl enabled issue\nGet overall stats for ssl enabled issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/ssl_enabled/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_ssl_enabled_hist", "desc": "Get historical occurrences of ssl enabled issue\nGet historical occurrences of ssl enabled issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/ssl_enabled/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_ssl_mixed", "desc": "Get ssl mixed issue\nGet all pages linking to a http link or pulling in a http resource", "method": "get", "path": "/sites/{site_id}/seov2/issues/ssl_mixed", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_ssl_mixed_details", "desc": "Get overall stats for ssl mixed issue\nGet overall stats for ssl mixed issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/ssl_mixed/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_ssl_mixed_hist", "desc": "Get historical occurrences of ssl mixed issue\nGet historical occurrences of ssl mixed issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/ssl_mixed/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_status_code_404", "desc": "Get status code 404 issue\nGet all links with status code 404", "method": "get", "path": "/sites/{site_id}/seov2/issues/status_code_404", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_status_code_404_details", "desc": "Get overall stats for status code 404 issue\nGet overall stats for status code 404 issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/status_code_404/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_status_code_404_hist", "desc": "Get historical occurrences of status code 404 issue\nGet historical occurrences of status code 404 issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/status_code_404/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_status_code_4xxs", "desc": "Get status code 4xx issue\nGet all links with status code 4xx", "method": "get", "path": "/sites/{site_id}/seov2/issues/status_code_4xxs", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_status_code_4xxs_details", "desc": "Get overall stats for status code 4xx issue\nGet overall stats for status code 4xx issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/status_code_4xxs/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_status_code_4xxs_hist", "desc": "Get historical occurrences of status code 4xx issue\nGet historical occurrences of status code 4xx issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/status_code_4xxs/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_status_code_500s", "desc": "Get status code 500 issue\nGet all links with status code 500", "method": "get", "path": "/sites/{site_id}/seov2/issues/status_code_500s", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_status_code_500s_details", "desc": "Get overall stats for status code 500 issue\nGet overall stats for status code 500 issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/status_code_500s/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_status_code_500s_hist", "desc": "Get historical occurrences of status code 500 issue\nGet historical occurrences of status code 500 issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/status_code_500s/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_structured_markup_pages", "desc": "Get structured markup pages issue\nGet structured markup pages issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/structured_markup_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_structured_markup_pages_details", "desc": "Get overall stats for structured markup pages issue\nGet overall stats for structured markup pages issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/structured_markup_pages/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_structured_markup_pages_hist", "desc": "Get historical occurrences of structured markup pages issue\nGet historical occurrences of structured markup pages issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/structured_markup_pages/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_touchscreen_ready_details", "desc": "Get touchscreen ready issue\nGet touchscreen ready issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/touchscreen_ready/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_unsafe_domain_details", "desc": "Get unsafe domain issue\nGet unsafe domain issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/unsafe_domain/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_updated_media", "desc": "Get updated media issue\nGet all media files not updated within the last year", "method": "get", "path": "/sites/{site_id}/seov2/issues/updated_media", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_issues_updated_media_details", "desc": "Get overall stats for updated media issue\nGet overall stats for updated media issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/updated_media/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_updated_media_hist", "desc": "Get historical occurrences of updated media issue\nGet historical occurrences of updated media issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/updated_media/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_updated_pages", "desc": "Get updated pages issue\nGet all pages not updated within the last year", "method": "get", "path": "/sites/{site_id}/seov2/issues/updated_pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_updated_pages_details", "desc": "Get overall stats for updated pages issue\nGet overall stats for updated pages issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/updated_pages/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_updated_pages_hist", "desc": "Get historical occurrences of updated pages issue\nGet historical occurrences of updated pages issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/updated_pages/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_urls_with_underscore", "desc": "Get urls with underscore issue\nGet all pages with an url that has an underscore", "method": "get", "path": "/sites/{site_id}/seov2/issues/urls_with_underscore", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_urls_with_underscore_details", "desc": "Get overall stats for urls with underscore issue\nGet overall stats for urls with underscore issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/urls_with_underscore/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_urls_with_underscore_hist", "desc": "Get historical occurrences of urls with underscore issue\nGet historical occurrences of urls with underscore issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/urls_with_underscore/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_issues_words_per_page", "desc": "Get words per page issue\nGet all pages with word count below 500", "method": "get", "path": "/sites/{site_id}/seov2/issues/words_per_page", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_issues_words_per_page_details", "desc": "Get overall stats for words per page issue\nGet overall stats for words per page issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/words_per_page/details", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_issues_words_per_page_hist", "desc": "Get historical occurrences of words per page issue\nGet historical occurrences of words per page issue", "method": "get", "path": "/sites/{site_id}/seov2/issues/words_per_page/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "seov2_overview_groups", "desc": "Get SEO groups\nGroups are used to display information for specific sections of the website. Only groups that are visible under your profile are returned.", "method": "get", "path": "/sites/{site_id}/seov2/overview/groups", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" } ] }, { "name": "seov2_overview_score", "desc": "Get the SEO scores\nGet the top category SEO scores for your website", "method": "get", "path": "/sites/{site_id}/seov2/overview/score", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "query", "description": "Id for specific page.", "required": false, "type": "integer", "format": "int64" } ] }, { "name": "seov2_overview_score_hist", "desc": "Get the SEO scores historically\nGet the top category SEO scores historically for your website", "method": "get", "path": "/sites/{site_id}/seov2/overview/score/history", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "period", "in": "query", "description": "Period for which to retrieve data. Default is last 7 days.\n\nA period can be a single date, a date range, or a predefined interval. Only full dates are allowed, not individual hours. Dates are in YYYYMMDD format only.\n\nA single date YYYYMMDD will return data for that day.\n\nA range of dates YYYYMMDD_YYYYMMDD will retrieve data for the period where the start and end date are both fully included.\n\nA predefined interval can be one of the following (case insensitive):\n\n now \n today \n yesterday \n last_seven_days \n last_week \n last_month \n this_month \n this_year", "required": false, "type": "string" } ] }, { "name": "seov2_pages", "desc": "Get pages with issues\nGet all pages found on your website with issues", "method": "get", "path": "/sites/{site_id}/seov2/pages", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "ids", "in": "query", "description": "Return all items that is one of the listed identifiers.\n\nValues are separated by comma, as in ids=1,2,3.", "required": false, "type": "array", "items": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 }, { "name": "query", "in": "query", "description": "Return all items that matches the specified plain text query.", "required": false, "type": "string" }, { "name": "search_in", "in": "query", "description": "Specified query must match either url or title.", "required": false, "type": "string", "enum": [ "url", "title" ], "default": "url" } ] }, { "name": "seov2_pages_issues", "desc": "Get issues for specific page\nGet the SEO issues found for the specific page", "method": "get", "path": "/sites/{site_id}/seov2/pages/{page_id}/issues", "params": [ { "name": "site_id", "in": "path", "description": "Id for specific site.", "required": true, "type": "integer", "format": "int64" }, { "name": "page_id", "in": "path", "description": "Id for specific page.", "required": true, "type": "integer", "format": "int64" }, { "name": "category", "in": "query", "description": "The category filter", "required": false, "type": "string", "enum": [ "none", "technical", "content", "ux", "mobile" ], "default": "none" }, { "name": "complexity", "in": "query", "description": "The complexity filter", "required": false, "type": "string", "enum": [ "none", "low", "medium", "high", "extreme" ], "default": "none" }, { "name": "fixed", "in": "query", "description": "The fixed filter", "required": false, "type": "boolean" }, { "name": "group_id", "in": "query", "description": "Id for specific group.", "required": false, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number to show when more than one page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, { "name": "page_size", "in": "query", "description": "Number of items/records per page in paged output.", "required": false, "type": "integer", "format": "int32", "default": 10, "minimum": 1, "maximum": 1000 } ] }, { "name": "_utilization", "desc": "Get the utilizations of the account\nGet the utilizations for this account.", "method": "get", "path": "/utilization", "params": [] } ]