Print a report

v2 (latest)

POST https://api.ap1.datadoghq.com/api/v2/reporting/printhttps://api.ap2.datadoghq.com/api/v2/reporting/printhttps://api.datadoghq.eu/api/v2/reporting/printhttps://api.ddog-gov.com/api/v2/reporting/printhttps://api.us2.ddog-gov.com/api/v2/reporting/printhttps://api.uk1.datadoghq.com/api/v2/reporting/printhttps://api.datadoghq.com/api/v2/reporting/printhttps://api.us3.datadoghq.com/api/v2/reporting/printhttps://api.us5.datadoghq.com/api/v2/reporting/print

Overview

Initiate a one-off, print-only report for a dashboard or integration dashboard. The report is rendered as a PDF and made available for download through the URL returned in the response. Requires a reporting permission appropriate to the targeted resource type.

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

The JSON:API data object for a print report request.

{
  "data": {
    "attributes": {
      "from_ts": 1780318800000,
      "resource_id": "abc-def-ghi",
      "resource_type": "dashboard",
      "template_variables": [
        {
          "name": "env",
          "values": [
            "prod"
          ]
        }
      ],
      "timeframe": "1w",
      "timezone": "America/New_York",
      "to_ts": 1780923600000
    },
    "type": "report"
  }
}

Response

Response containing the initiated print-only report.

Expand All

Field

Type

Description

data [required]

object

The JSON:API data object for a print-only report.

{
  "data": {
    "attributes": {
      "download_url": "https://app.datadoghq.com/...",
      "from_ts": 1780318800000,
      "resource_id": "abc-def-ghi",
      "resource_type": "dashboard",
      "template_variables": [
        {
          "name": "env",
          "values": [
            "prod"
          ]
        }
      ],
      "timeframe": "1w",
      "timezone": "America/New_York",
      "to_ts": 1780923600000
    },
    "id": "11111111-2222-3333-4444-555555555555",
    "type": "report"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Unprocessable Entity

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  ## default
# 

# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/reporting/print" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "resource_id": "abc-def-ghi",
      "resource_type": "dashboard",
      "template_variables": [
        {
          "name": "env",
          "values": [
            "prod"
          ]
        }
      ],
      "timeframe": "1w",
      "timezone": "America/New_York"
    },
    "type": "report"
  }
}
EOF

                

"""
Print a report returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.report_schedules_api import ReportSchedulesApi
from datadog_api_client.v2.model.print_report_request import PrintReportRequest
from datadog_api_client.v2.model.print_report_request_attributes import PrintReportRequestAttributes
from datadog_api_client.v2.model.print_report_request_data import PrintReportRequestData
from datadog_api_client.v2.model.print_report_type import PrintReportType
from datadog_api_client.v2.model.report_schedule_resource_type import ReportScheduleResourceType
from datadog_api_client.v2.model.report_schedule_template_variable import ReportScheduleTemplateVariable

body = PrintReportRequest(
    data=PrintReportRequestData(
        attributes=PrintReportRequestAttributes(
            from_ts=1780318800000,
            resource_id="abc-def-ghi",
            resource_type=ReportScheduleResourceType.DASHBOARD,
            template_variables=[
                ReportScheduleTemplateVariable(
                    name="env",
                    values=[
                        "prod",
                    ],
                ),
            ],
            timeframe="1w",
            timezone="America/New_York",
            to_ts=1780923600000,
        ),
        type=PrintReportType.REPORT,
    ),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = ReportSchedulesApi(api_client)
    response = api_instance.print_report(body=body)

    print(response)

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"

# Print a report returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::ReportSchedulesAPI.new

body = DatadogAPIClient::V2::PrintReportRequest.new({
  data: DatadogAPIClient::V2::PrintReportRequestData.new({
    attributes: DatadogAPIClient::V2::PrintReportRequestAttributes.new({
      from_ts: 1780318800000,
      resource_id: "abc-def-ghi",
      resource_type: DatadogAPIClient::V2::ReportScheduleResourceType::DASHBOARD,
      template_variables: [
        DatadogAPIClient::V2::ReportScheduleTemplateVariable.new({
          name: "env",
          values: [
            "prod",
          ],
        }),
      ],
      timeframe: "1w",
      timezone: "America/New_York",
      to_ts: 1780923600000,
    }),
    type: DatadogAPIClient::V2::PrintReportType::REPORT,
  }),
})
p api_instance.print_report(body)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"

// Print a report returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)

func main() {
	body := datadogV2.PrintReportRequest{
		Data: datadogV2.PrintReportRequestData{
			Attributes: datadogV2.PrintReportRequestAttributes{
				FromTs:       datadog.PtrInt64(1780318800000),
				ResourceId:   "abc-def-ghi",
				ResourceType: datadogV2.REPORTSCHEDULERESOURCETYPE_DASHBOARD,
				TemplateVariables: []datadogV2.ReportScheduleTemplateVariable{
					{
						Name: "env",
						Values: []string{
							"prod",
						},
					},
				},
				Timeframe: datadog.PtrString("1w"),
				Timezone:  "America/New_York",
				ToTs:      datadog.PtrInt64(1780923600000),
			},
			Type: datadogV2.PRINTREPORTTYPE_REPORT,
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewReportSchedulesApi(apiClient)
	resp, r, err := api.PrintReport(ctx, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReportSchedulesApi.PrintReport`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `ReportSchedulesApi.PrintReport`:\n%s\n", responseContent)
}

Instructions

First install the library and its dependencies and then save the example to main.go and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"

// Print a report returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ReportSchedulesApi;
import com.datadog.api.client.v2.model.PrintReportRequest;
import com.datadog.api.client.v2.model.PrintReportRequestAttributes;
import com.datadog.api.client.v2.model.PrintReportRequestData;
import com.datadog.api.client.v2.model.PrintReportResponse;
import com.datadog.api.client.v2.model.PrintReportType;
import com.datadog.api.client.v2.model.ReportScheduleResourceType;
import com.datadog.api.client.v2.model.ReportScheduleTemplateVariable;
import java.util.Collections;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    ReportSchedulesApi apiInstance = new ReportSchedulesApi(defaultClient);

    PrintReportRequest body =
        new PrintReportRequest()
            .data(
                new PrintReportRequestData()
                    .attributes(
                        new PrintReportRequestAttributes()
                            .fromTs(1780318800000L)
                            .resourceId("abc-def-ghi")
                            .resourceType(ReportScheduleResourceType.DASHBOARD)
                            .templateVariables(
                                Collections.singletonList(
                                    new ReportScheduleTemplateVariable()
                                        .name("env")
                                        .values(Collections.singletonList("prod"))))
                            .timeframe("1w")
                            .timezone("America/New_York")
                            .toTs(1780923600000L))
                    .type(PrintReportType.REPORT));

    try {
      PrintReportResponse result = apiInstance.printReport(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ReportSchedulesApi#printReport");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Instructions

First install the library and its dependencies and then save the example to Example.java and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"

// Print a report returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_report_schedules::ReportSchedulesAPI;
use datadog_api_client::datadogV2::model::PrintReportRequest;
use datadog_api_client::datadogV2::model::PrintReportRequestAttributes;
use datadog_api_client::datadogV2::model::PrintReportRequestData;
use datadog_api_client::datadogV2::model::PrintReportType;
use datadog_api_client::datadogV2::model::ReportScheduleResourceType;
use datadog_api_client::datadogV2::model::ReportScheduleTemplateVariable;

#[tokio::main]
async fn main() {
    let body = PrintReportRequest::new(PrintReportRequestData::new(
        PrintReportRequestAttributes::new(
            "abc-def-ghi".to_string(),
            ReportScheduleResourceType::DASHBOARD,
            vec![ReportScheduleTemplateVariable::new(
                "env".to_string(),
                vec!["prod".to_string()],
            )],
            "America/New_York".to_string(),
        )
        .from_ts(1780318800000)
        .timeframe("1w".to_string())
        .to_ts(1780923600000),
        PrintReportType::REPORT,
    ));
    let configuration = datadog::Configuration::new();
    let api = ReportSchedulesAPI::with_config(configuration);
    let resp = api.print_report(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

Instructions

First install the library and its dependencies and then save the example to src/main.rs and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run

/**
 * Print a report returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v2.ReportSchedulesApi(configuration);

const params: v2.ReportSchedulesApiPrintReportRequest = {
  body: {
    data: {
      attributes: {
        fromTs: 1780318800000,
        resourceId: "abc-def-ghi",
        resourceType: "dashboard",
        templateVariables: [
          {
            name: "env",
            values: ["prod"],
          },
        ],
        timeframe: "1w",
        timezone: "America/New_York",
        toTs: 1780923600000,
      },
      type: "report",
    },
  },
};

apiInstance
  .printReport(params)
  .then((data: v2.PrintReportResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

Instructions

First install the library and its dependencies and then save the example to example.ts and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"

Print a report

Overview

Request

Body Data (required)

Response

Code Example

Print a report

Print a report

Instructions

Print a report

Instructions

Print a report

Instructions

Print a report

Instructions

Print a report

Instructions

Print a report

Instructions

How can I help you today?