#!/usr/bin/python
# -*- coding: utf-8 -*-

# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)

DOCUMENTATION = r"""
---
module: site_kpi_summaries_summary_analytics_v1_info
short_description: Information module for Site Kpi Summaries Summary Analytics V1
description:
- Get all Site Kpi Summaries Summary Analytics V1.
- >
   Get site analytics summary data for the given task id. For detailed information about the usage of the API, please
   refer to the Open API specification document - https //github.com/cisco-en-programmability/catalyst-center-api-
   specs/blob/main/Assurance/CE_Cat_Center_Org-SiteKpiSummaries-1.0.0-resolved.yaml.
version_added: '6.17.0'
extends_documentation_fragment:
  - cisco.dnac.module_info
author: Rafael Campos (@racampos)
options:
  headers:
    description: Additional headers.
    type: dict
  taskId:
    description:
    - >
      TaskId query parameter. Used to retrieve asynchronously processed & stored data. When this parameter is
      used, the rest of the request params will be ignored.
    type: str
requirements:
- dnacentersdk >= 2.4.9
- python >= 3.5
seealso:
- name: Cisco DNA Center documentation for Sites GetSiteAnalyticsSummaryDataForTheGivenTaskIdV1
  description: Complete reference of the GetSiteAnalyticsSummaryDataForTheGivenTaskIdV1 API.
  link: https://developer.cisco.com/docs/dna-center/#!get-site-analytics-summary-data-for-the-given-task-id
notes:
  - SDK Method used are
    sites.Sites.get_site_analytics_summary_data_for_the_given_task_id_v1,

  - Paths used are
    get /dna/data/api/v1/siteKpiSummaries/summaryAnalytics,

"""

EXAMPLES = r"""
- name: Get all Site Kpi Summaries Summary Analytics V1
  cisco.dnac.site_kpi_summaries_summary_analytics_v1_info:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    headers: "{{my_headers | from_json}}"
    taskId: string
  register: result

"""
RETURN = r"""
dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python SDK
  returned: always
  type: dict
  sample: >
    {
      "response": {
        "attributes": [
          {
            "name": "string",
            "value": 0
          }
        ]
      },
      "version": "string"
    }
"""
