Obtenha o histórico do relatório

GET
https://api.digicert.com/reports/v1/report/history

Use este ponto de extremidade para obter todos os relatórios atualmente programados para geração.

O recurso Biblioteca de relatórios deve estar habilitado em sua conta para que este endpoint responda com sucesso.

cURL
curl -X GET \
  'https://www.digicert.com/services/v2/reports/preview/report/history' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'
Python
import requests

url = "https://www.digicert.com/services/v1/reports/preview/reporth/history"

payload={}
headers = {
  'Content-Type': 'application/json',
  'X-DC-DEVKEY': {{api_key}},
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
Go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://www.digicert.com/services/v1/reports/preview/report/history"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("X-DC-DEVKEY", {{api_key}})

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
NodeJS
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://www.digicert.com/services/v1/reports/preview/report/history',
  'headers': {
    'Content-Type': 'application/json',
    'X-DC-DEVKEY': {{api_key}},
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
204 No Content
{
    "page": {
        "total": 1,
        "limit": 1,
        "offset": 0
    },
    "report_history": [
        {
            "report_display_name": "RPT01",
            "report_identifier": "52150de8-3c97-4802-bc18-e419d2c713fc",
            "report_run_identifier": "84604797-430a-470a-bb0d-156de649b92c",
            "created_by_user_id": 10192344,
            "created_by_user_name": "Abhijeeta Mohanty",
            "created_date": "2021-01-13 02:15:48",
            "report_type": "orders",
            "report_type_display_name": "Orders",
            "report_start_date": "2021-01-13 09:15:37",
            "report_end_date": "2021-01-13 09:15:48",
            "schedule": "WEEKLY", 
            "format": [
                "CSV" /
            ],
            "status": "READY"
        }
    ]
}
400 Invalid offset
{
    "code": "invalid_offset",
    "message": "Offset should be zero or positive integer"
}
400 Invalid limit
{
"code": "invalid_limit",
"message": "Limit should be positive integer"
}
401 Invalid user
{
"code": "user_authentication_error",
"message": "User is not authenticated."
}
403 Forbidden
{
    "code": "user_forbidden",
    "message": "User does not have the required permission."
}
403 Not enabled
{
    "code": "custom_reports_not_enabled",
    "message": "Custom reports is not enabled"
}

Parâmetros de consulta

Nome Obr/Opc Tipo Descrição
offset opcional integer O número de registros a serem incluídos na resposta. Deve ser maior ou igual a 0. Predefinição: 0.
limit opcional integer O número de páginas a serem incluídas na resposta. Predefinição: 100.
report_display_name opcional string O nome do relatório exibido. Vários nomes de relatório são separados por uma vírgula.
schedule opcional string A frequência de criação do relatório. Valores possíveis: ON_DEMAND, WEEKLY, MONTHLY.
status opcional string O status do relatório. Todos os relatórios programados são ACTIVE.
report_type opcional string O tipo de relatório.
search opcional string O termo a ser usado como filtro de pesquisa. A pesquisa parcial é suportada.
sort_by opcional string Parâmetro no qual a classificação será feita. Parâmetros suportados para classificação: report_display_name, report_type, schedule, format. Se nenhum parâmetro sort_by for fornecido, o padrão é report_start_date.
sort_direction opcional string A direção pode ser ASC (ascendente) ou DESC (descendente). O padrão é ASC, a menos que a coluna de classificação e sort_direction estejam vazios. Nesse caso, a classificação será baseada em report_start_date (coluna de classificação padrão) na ordem DESC.

Parâmetros da resposta

Nome Tipo Descrição
page object Recipiente
.. total integer O número de relatórios programados para geração.
.. limit integer O número de páginas a serem incluídas na resposta. Predefinição: 100.
.. offset integer O número de registros a serem incluídos na resposta. Deve ser maior ou igual a 0. Predefinição: 0.
report_history container Recipiente.
.. report_display_name string O nome do relatório exibido. Vários nomes de relatório são separados por uma vírgula.
.. report_identifier string ID do relatório exibido na resposta de Criar API de relatório.
.. report_run_identifier string O ID associado à geração do relatório. Este valor é exibido na Criar API de relatório.
.. created_by_user_id string O ID do usuário associado à pessoa que está criando o relatório.
.. created_date string A data de criação do relatório, incluindo o carimbo de data/hora no formato: AA-MM-DD HH - MM-SS.
.. created_by_user_name string O nome de usuário Digicert associado à criação do relatório.
.. report_type string O tipo de relatório. Consulte Listar API de tipos de relatórios suportados para obter mais informações.
.. report_type_display_name string O nome especificado como o tipo de relatório.
.. report_start_date date A data de início para a criação do relatório. Formato: AA-MM-DD.
.. report_end_date date A data de término para a criação do relatório. Formato: AA-MM-DD.
.. schedule string A frequência de criação do relatório. Valores possíveis: ON_DEMAND, WEEKLY, MONTHLY.
.. format string O formato do relatório. Para este terminal, o valor possível é CSV. Para retornar um relatório em JSON, consulte Obter API de relatório JSON.
.. status string O status do relatório. Os valores permitidos são GENERATING, READY, FAILED, SCHEDULED.
.. manually_triggered boolean Se a geração do relatório é manual ou gerada pelo sistema.