Richiedi cronologia report

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

Usa questo endpoint per ottenere tutti i report attualmente programmati per la generazione.

La funzione Libreria report deve essere abilitata nel tuo account affinché questo endpoint risponda correttamente.

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"
}

Parametri di query

Nome Rich/Opz Tipo Descrizione
offset facoltativo integer Numero di record da includere nella risposta. Deve essere superiore o pari a 0. Impostazione predefinita: 0.
limit facoltativo integer Numero di pagine da includere nella risposta. Impostazione predefinita: 100.
report_display_name facoltativo string Nome del report visualizzato. Più nomi di report sono separati da una virgola.
schedule facoltativo string La frequenza della creazione del report. Valori possibili: ON_DEMAND, WEEKLY, MONTHLY.
status facoltativo string Stato del report. Tutti i report programmati sono ACTIVE.
report_type facoltativo string Tipo di report.
search facoltativo string Il termine da usare come filtro per la ricerca. È supportata la ricerca parziale.
sort_by facoltativo string Parametro su cui sarà effettuato l’ordinamento. Parametri supportati per l’ordinamento: report_display_name, report_type, schedule, format. Se non è fornito alcun parametro sort_by, l’impostazione predefinita è report_start_date.
sort_direction facoltativo string La direzione può essere ASC (crescente) o DESC (decrescente). L’impostazione predefinita è ASC, a meno che sia la colonna di ordinamento che sort_direction non sono vuoti. In questo caso, l’ordinamento si baserà su report_start_date (colonna di ordinamento predefinita) nell’ordine DESC.

Parametri di risposta

Nome Tipo Descrizione
page object Contenitore
.. total integer Numero di report programmati per la generazione.
.. limit integer Numero di pagine da includere nella risposta. Impostazione predefinita: 100.
.. offset integer Numero di record da includere nella risposta. Deve essere superiore o pari a 0. Impostazione predefinita: 0.
report_history container Contenitore.
.. report_display_name string Nome del report visualizzato. Più nomi di report sono separati da una virgola.
.. report_identifier string ID report visualizzato nella risposta dell’API Crea report.
.. report_run_identifier string ID associato alla generazione del report. Questo valore viene visualizzato nell’API Crea report.
.. created_by_user_id string ID utente associato alla persona che crea il report.
.. created_date string La data di creazione del report, compresa la data e l’ora nel formato: AA-MM-GG HH--MM-SS.
.. created_by_user_name string Username Digicert associato alla creazione report.
.. report_type string Tipo di report. Consulta l’API Elenca tipi di report supportati per ulteriori informazioni.
.. report_type_display_name string Il nome specificato come tipo di report.
.. report_start_date date La data di inizio per la creazione del report. Formato: AA-MM-GG.
.. report_end_date date La data di fine per la creazione del report. Formato: AA-MM-GG.
.. schedule string La frequenza della creazione del report. Valori possibili: ON_DEMAND, WEEKLY, MONTHLY.
.. format string Formato per il report. Per questo endpoint, il valore possibile è CSV. Per riportare un report in JSON, consulta l’API Richiedi report JSON.
.. status string Stato del report. I valori consentiti sono GENERATING, READY, FAILED, SCHEDULED.
.. manually_triggered boolean Se la generazione di report è manuale o generata dal sistema.