Exportar/importar definições de relatório personalizadas

Esta é a documentação do Apigee Edge.
Acesse Documentação da Apigee X.
informações

Use as APIs do Edge para exportar e importar relatórios personalizados de um ambiente organizacional para outro. Essa técnica útil permite reutilizar designs de relatórios personalizados que quiser em diferentes organizações e e ambientes de teste. Além disso, você pode armazenar o design (um arquivo de texto JSON simples) no seu CSV.

Primeiro, use as definições de relatório de análise de listas. API para receber os UUIDs de todos os relatórios definidos para uma organização:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/org-name/reports" \
  -u email:password 

Para cada relatório, o resultado contém seu nome de exibição (o nome que você vê na interface do Edge) e seu UUID:

{
  "qualifier": [
    {
      "displayName": "My Report 1",
      "name": "cb7cd16a-44c4-0bc83c3b9c92"
    },
    {
      "displayName": "My Other Report",
      "name": "a7e3fc4e-992a2ffc0e3d49d"
    },
    ...
  ]
}

Agora, use o UUID do relatório desejado para recuperar a definição dele chamando o método Conferir a definição de um relatório de análise API. Neste exemplo, você recebe a definição do relatório chamada "Meu relatório 1":

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/org-name/reports/cb7cd16a-44c4-0bc83c3b9c92" \
  -u email:password 

A saída contém a definição do relatório:

{
  "chartType": "column",
  "comments": [],
  "createdAt": 1506922614000,
  "createdBy": "11.111.121.57",
  "dimensions": [
    "apiproxy",
    "proxy_pathsuffix",
    "proxy_client_ip"
  ],
  "displayName": "My Report 1",
  "environment": "prod",
  "lastModifiedAt": 1512435450000,
  "lastModifiedBy": "111.111.121.57",
  "lastViewedAt": 1512435450000,
  "metrics": [
    {
      "function": "avg",
      "name": "response_size"
    },
    {
      "function": "avg",
      "name": "request_size"
    }
  ],
  "name": "cb7cd16a-44c4-0bc83c3b9c92",
  "organization": "myOrg",
  "properties": [
    {
      "property": "__ui__",
      "value": [
        {
          "name": "description"
        },
        {
          "name": "accuracy"
        }
      ]
    }
  ],
  "sortbyCols": [],
  "tags": [],
  "timeUnit": "hour"
}

Copie a saída JSON e atualize os campos environment e organization conforme necessário para o destino e, em seguida, importar a definição usando o método Criar uma API de definição de relatório de análise.

Por exemplo, se você quiser importar a definição para o ambiente test de uma organização chamada destOrg:

curl -X POST -H "Content-Type: application/json" "https://api.enterprise.apigee.com/v1/organizations/destOrg/reports" \
-d "{
  "chartType": "column",
  "comments": [],
  "createdAt": 1506922614000,
  "createdBy": "11.111.121.57",
  "dimensions": [
    "apiproxy",
    "proxy_pathsuffix",
    "proxy_client_ip"
  ],
  "displayName": "My Report 1",
  "environment": "test",
  "lastModifiedAt": 1512435450000,
  "lastModifiedBy": "111.111.121.57",
  "lastViewedAt": 1512435450000,
  "metrics": [
    {
      "function": "avg",
      "name": "response_size"
    },
    {
      "function": "avg",
      "name": "request_size"
    }
  ],
  "name": "cb7cd16a-44c4-0bc83c3b9c92",
  "organization": "destOrg",
  "properties": [
    {
      "property": "__ui__",
      "value": [
        {
          "name": "description"
        },
        {
          "name": "accuracy"
        }
      ]
    }
  ],
  "sortbyCols": [],
  "tags": [],
  "timeUnit": "hour"
}" \
-u email:password 

Agora o relatório deve aparecer na interface do Edge da organização.