Skip to content

Read a Report definition

View the full schema here.

This endpoint allows you to retrieve information about a report without running it. The response will contain the report definition, including the report's name, description, and the report's configuration.

curl \
  --get \
  --header "Authorization: Bearer ${ARDOQ_API_TOKEN}" \
  --header "X-org: ${ARDOQ_ORG_LABEL}" \
  --fail-with-body \
  "${ARDOQ_API_HOST-"https://app.ardoq.com"}/api/v2/reports/63ea1a02bbed2e0001a19a9c"

resp = ardoq_request("/api/v2/reports/63ea1a02bbed2e0001a19a9c")
print(resp)

(async () => {
    const resp = await ardoq_request(`/api/v2/reports/63ea1a02bbed2e0001a19a9c`)
    console.log(resp)
})()

Example Result

{
  "_id": "63ea1a02bbed2e0001a19a9c",
  "_version": 1,
  "name": "The best of reports",
  "datasource": "graphSearch",
  "columns": [
    {"label": "Name"},
    {"label": "Strategic Rating"},
    {"label": "Recommended Migration Strategy"},
    {"label": "Migration Strategy"},
    {"label": "SaaS Alternative"},
    {"label": "Lifecycle Phase"},
    {"label": "Total Cost (USD)"},
    {"label": "Total Supporting Infrastructure"},
    {"label": "Total Integrations"},
    {"label": "Total Capabilities Realized"},
  ],
  "description": "string",
  "_meta": {
    "created": "2023-09-12T09:35:25.415Z",
    "createdBy": "650095970d99b1000160e591",
    "lastUpdated": "2023-09-12T10:07:52.456Z",
    "lastModifiedBy": "6500966c0d99b1000160e592",
    "createdByEmail": "creator@ardoq.com",
    "createdByName": "Mr. Ardoq",
    "lastModifiedByEmail": "updater@ardoq.com",
    "lastModifiedByName": "Ms. Ardoq"
  }
}