获取报告历史记录

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)

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`都为空。在这种情况下，将基于`report_start_date`（默认排序列）按`DESC`排列。

响应参数

名称	类型	描述
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	手动还是系统生成报告。

查询参数

响应参数

简介