取得報告歷史記錄

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

使用此端點目前安排要產生的所有報告。

若要讓此端點成功回應,您必須在您的帳戶中啟用「報告程式庫」功能。

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

查詢參數

名稱 必填/選填 類型 說明
offset 選填 integer 包含在回應中的總記錄數。必須大於或等於 0 個。預設:0.
limit 選填 integer 包含在回應中的總頁數。預設:100.
report_display_name 選填 string 顯示的報告名稱。多個報告名稱以逗號分隔。
schedule 選填 string 建立報告的頻率。可能的值:ON_DEMAND, WEEKLY, MONTHLY
status 選填 string 報告的狀態。所有排程的報告都 ACTIVE
report_type 選填 string 報告的類型。
search 選填 string 作為搜尋篩選條件的詞彙。支援部份搜尋。
sort_by 選填 string 完成排序的參數。用於排序的支援參數:report_display_name, report_type, schedule, format. 如果未提供 sort_by 參數,預設為 report_start_date
sort_direction 選填 string 方向可能是 ASC (升冪) 或 DESC (降冪)。預設為 ASC,除非兩個排序欄和 sort_direction 都是空的。在此情況中,將依照 DESC 順序的 report_start_date (預設排序欄) 排序。

回應參數

名稱 類型 說明
page object 容器
.. total integer 安排要產生的報告數目。
.. limit integer 包含在回應中的總頁數。預設:100.
.. offset integer 包含在回應中的總記錄數。必須大於或等於 0 個。預設:0.
report_history container 容器。
.. report_display_name string 顯示的報告名稱。多個報告名稱以逗號分隔。
.. report_identifier string 顯示在建立報告 API 的回應中的報告 ID。
.. report_run_identifier string 與報告的產生關聯的 ID。此值顯示在建立報告 API 中。
.. created_by_user_id string 與建立報告人關聯的使用者 ID。
.. created_date string 報告的建立日期,包括以下格式的時間戳記:年-月-日 時-分-秒。
.. created_by_user_name string 與建立報告關聯的 DigiCert 使用者名稱。
.. report_type string 報告類型。如需更多資訊,請參閱列出支援的報告類型 API
.. report_type_display_name string 指定為報告類型的名稱。
.. report_start_date date 建立報告的開始日期。格式:年-月-日。
.. report_end_date date 建立報告的結束日期。格式:年-月-日。
.. schedule string 建立報告的頻率。可能的值:ON_DEMAND, WEEKLY, MONTHLY
.. format string 報告的格式。關於此端點,可能的值是 CSV。若要在 JSON 中傳回報告,請參閱取得 JSON 報告 API
.. status string 報告的狀態。允許的值是 GENERATING, READY, FAILED, SCHEDULED
.. manually_triggered boolean 報告產生是手動或系統產生。