Skip to content

List Report definitions

View the full schema here.

This endpoint allows you to retrieve information about a multiple reports without running them. The responses 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}" \
  --data-urlencode "name=My Report" \
  --fail-with-body \
  "${ARDOQ_API_HOST-"https://app.ardoq.com"}/api/v2/reports"

query={"name":"My Report"}
resp = ardoq_request("/api/v2/reports",query=query)
print(resp)

(async () => {
    query=`name=My Report`
    const resp = await ardoq_request(`/api/v2/reports?${query}`)
    console.log(resp)
})()

Example Result

{
  "values": [
    {
      "_id": "63ea1a02bbed2e0001a19a9c",
      "_version": 1,
      "name": "The best of reports",
      "datasource": "graphSearch",
      "columns": [
        {"label": "Name", "key": "name"},
        {"label": "Strategic Rating", "key": "strategic_rating"},
        {"label": "Recommended Migration Strategy", "key": "recommended_migration_strategy"},
        {"label": "Migration Strategy", "key": "migration_strategy"},
        {"label": "SaaS Alternative", "key": "saas_alternative"},
        {"label": "Lifecycle Phase", "key": "lifecycle_phase"}        
      ],
      "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"
      }
    }
  ],
  "_links": {},
  "_meta": {}
}