Skip to main content
Version: 0.0.1

Reflection Summary (23.x and earlier) {{< chip enterprise >}}

Use the Reflection API to retrieve a reflection summary that includes the raw and aggregation reflections for the Dremio instance.

Reflection summary objects are different from reflection objects. Reflection summaries do not include certain attributes that define the reflection, like the display, dimension, measure, sort, and partition attributes. Reflection summaries do include several attributes that do not appear in reflection objects, like datasetType and datasetPath.

{{< codeheader "Reflection Summary Object" >}}

{
  "data": [
    {
      "id": "85dda9dd-2371-467f-b68d-fc4c5ea57a8b",
      "type": "AGGREGATION",
      "name": "Aggregation Reflection",
      "createdAt": "2022-07-05T19:19:40.244Z",
      "updatedAt": "2023-01-10T17:12:30.244Z",
      "currentSizeBytes": 18639885,
      "totalSizeBytes": 142639924,
      "enabled": true,
      "arrowCachingEnabled": false,
      "status": {
        "config": "OK",
        "refresh": "SCHEDULED",
        "availability": "AVAILABLE",
        "combinedStatus": "CAN_ACCELERATE",
        "failureCount": 0,
        "lastDataFetch": "2023-01-23T19:37:37.030Z",
        "expiresAt": "3022-01-24T19:37:37.030Z"
      },
      "datasetId": "ef99ab32-c2d4-4d1c-9e91-2c8be861bb8a",
      "datasetType": "VIRTUAL_DATASET",
      "datasetPath": [
        "Business",
        "Transportation",
        "NYC Taxi Trips"
      ],
      "canView": true,
      "canAlter": true,
      "entityType": "reflection-summary"
    },
    {
      "id": "51d76efd-225a-4799-a557-642810edef73",
      "type": "AGGREGATION",
      "name": "Aggregation Reflection",
      "createdAt": "2023-01-20T15:48:11.815Z",
      "updatedAt": "2023-01-20T15:48:11.815Z",
      "currentSizeBytes": 5488681,
      "totalSizeBytes": 16464596,
      "enabled": true,
      "arrowCachingEnabled": false,
      "status": {
        "config": "OK",
        "refresh": "SCHEDULED",
        "availability": "AVAILABLE",
        "combinedStatus": "CAN_ACCELERATE",
        "failureCount": 0,
        "lastDataFetch": "2023-01-25T16:35:20.689Z",
        "expiresAt": "2023-01-25T19:35:20.689Z"
      },
      "datasetId": "ed4b20c1-8ec5-4d4e-a2a0-f543bc74021b",
      "datasetType": "VIRTUAL_DATASET",
      "datasetPath": [
        "Business",
        "NYC-taxi-trips-by-distance"
      ],
      "canView": true,
      "canAlter": true,
      "entityType": "reflection-summary"
    },
    {
      "id": "fbd9f73a-d7a9-49d5-a2b6-efdd88fa9199",
      "type": "AGGREGATION",
      "name": "Aggregation Reflection",
      "createdAt": "2022-11-11T17:10:36.167Z",
      "updatedAt": "2022-11-11T17:10:36.167Z",
      "currentSizeBytes": 0,
      "totalSizeBytes": 0,
      "enabled": true,
      "arrowCachingEnabled": false,
      "status": {
        "config": "OK",
        "refresh": "GIVEN_UP",
        "availability": "NONE",
        "combinedStatus": "FAILED",
        "failureCount": 3,
        "lastDataFetch": "1969-12-31T23:59:59.999Z",
        "expiresAt": "1969-12-31T23:59:59.999Z"
      },
      "datasetId": "cfdc6530-8d5c-44d1-a85e-d43daca1c70f",
      "datasetType": "VIRTUAL_DATASET",
      "datasetPath": [
        "demo",
        "nyc-taxi-view-test"
      ],
      "canView": true,
      "canAlter": true,
      "entityType": "reflection-summary"
    },
    {
      "id": "14f22052-cbb3-4d5d-8bbc-6154cca98e49",
      "type": "RAW",
      "name": "listings",
      "createdAt": "2022-07-12T16:45:35.249Z",
      "updatedAt": "2022-07-12T16:45:35.249Z",
      "currentSizeBytes": 0,
      "totalSizeBytes": 0,
      "enabled": true,
      "arrowCachingEnabled": true,
      "status": {
        "config": "OK",
        "refresh": "MANUAL",
        "availability": "NONE",
        "combinedStatus": "CANNOT_ACCELERATE_MANUAL",
        "failureCount": 0,
        "lastDataFetch": "1969-12-31T23:59:59.999Z",
        "expiresAt": "1969-12-31T23:59:59.999Z"
      },
      "datasetId": "7707981c-cb33-42bc-a048-d27a8915f468",
      "datasetType": "PHYSICAL_DATASET",
      "datasetPath": [
        "Samples (9)",
        "samples.dremio.com",
        "Dremio University",
        "airbnb_listings.csv"
      ],
      "canView": true,
      "canAlter": true,
      "entityType": "reflection-summary"
    }
  ]
}

Reflection Summary Attributes​

{{< api-section file="data/software-api/reflection.json" data="reflectionSummary23Attributes" >}}

data​

{{< api-section file="data/software-api/reflection.json" data="dataSummary23Attributes" >}}

status​

{{< api-section file="data/software-api/reflection.json" data="statusSummary23Attributes" >}}

Retrieving a Reflection Summary​

Retrieve a summary of the raw and aggregation reflections in the Dremio instance.

{{< codeheader "Method and URL" >}}

GET /api/v3/reflection/summary

{{< codeheader "Example Request" >}}

curl -X GET 'https://{hostname}/v3/api/reflection/summary'
--header 'Authorization: _dremio{tokenstring}' \
--header "Content-Type: application/json"

{{< codeheader "Example Response" >}}

{
  "data": [
    {
      "id": "85dda9dd-2371-467f-b68d-fc4c5ea57a8b",
      "type": "AGGREGATION",
      "name": "Aggregation Reflection",
      "createdAt": "2022-07-05T19:19:40.244Z",
      "updatedAt": "2023-01-10T17:12:30.244Z",
      "currentSizeBytes": 18639885,
      "totalSizeBytes": 142639924,
      "enabled": true,
      "arrowCachingEnabled": false,
      "status": {
        "config": "OK",
        "refresh": "SCHEDULED",
        "availability": "AVAILABLE",
        "combinedStatus": "CAN_ACCELERATE",
        "failureCount": 0,
        "lastDataFetch": "2023-01-23T19:37:37.030Z",
        "expiresAt": "3022-01-24T19:37:37.030Z"
      },
      "datasetId": "ef99ab32-c2d4-4d1c-9e91-2c8be861bb8a",
      "datasetType": "VIRTUAL_DATASET",
      "datasetPath": [
        "Business",
        "Transportation",
        "NYC Taxi Trips"
      ],
      "canView": true,
      "canAlter": true,
      "entityType": "reflection-summary"
    },
    {
      "id": "51d76efd-225a-4799-a557-642810edef73",
      "type": "AGGREGATION",
      "name": "Aggregation Reflection",
      "createdAt": "2023-01-20T15:48:11.815Z",
      "updatedAt": "2023-01-20T15:48:11.815Z",
      "currentSizeBytes": 5488681,
      "totalSizeBytes": 16464596,
      "enabled": true,
      "arrowCachingEnabled": false,
      "status": {
        "config": "OK",
        "refresh": "SCHEDULED",
        "availability": "AVAILABLE",
        "combinedStatus": "CAN_ACCELERATE",
        "failureCount": 0,
        "lastDataFetch": "2023-01-25T16:35:20.689Z",
        "expiresAt": "2023-01-25T19:35:20.689Z"
      },
      "datasetId": "ed4b20c1-8ec5-4d4e-a2a0-f543bc74021b",
      "datasetType": "VIRTUAL_DATASET",
      "datasetPath": [
        "Business",
        "NYC-taxi-trips-by-distance"
      ],
      "canView": true,
      "canAlter": true,
      "entityType": "reflection-summary"
    },
    {
      "id": "fbd9f73a-d7a9-49d5-a2b6-efdd88fa9199",
      "type": "AGGREGATION",
      "name": "Aggregation Reflection",
      "createdAt": "2022-11-11T17:10:36.167Z",
      "updatedAt": "2022-11-11T17:10:36.167Z",
      "currentSizeBytes": 0,
      "totalSizeBytes": 0,
      "enabled": true,
      "arrowCachingEnabled": false,
      "status": {
        "config": "OK",
        "refresh": "GIVEN_UP",
        "availability": "NONE",
        "combinedStatus": "FAILED",
        "failureCount": 3,
        "lastDataFetch": "1969-12-31T23:59:59.999Z",
        "expiresAt": "1969-12-31T23:59:59.999Z"
      },
      "datasetId": "cfdc6530-8d5c-44d1-a85e-d43daca1c70f",
      "datasetType": "VIRTUAL_DATASET",
      "datasetPath": [
        "demo",
        "nyc-taxi-view-test"
      ],
      "canView": true,
      "canAlter": true,
      "entityType": "reflection-summary"
    },
    {
      "id": "14f22052-cbb3-4d5d-8bbc-6154cca98e49",
      "type": "RAW",
      "name": "listings",
      "createdAt": "2022-07-12T16:45:35.249Z",
      "updatedAt": "2022-07-12T16:45:35.249Z",
      "currentSizeBytes": 0,
      "totalSizeBytes": 0,
      "enabled": true,
      "arrowCachingEnabled": true,
      "status": {
        "config": "OK",
        "refresh": "MANUAL",
        "availability": "NONE",
        "combinedStatus": "CANNOT_ACCELERATE_MANUAL",
        "failureCount": 0,
        "lastDataFetch": "1969-12-31T23:59:59.999Z",
        "expiresAt": "1969-12-31T23:59:59.999Z"
      },
      "datasetId": "7707981c-cb33-42bc-a048-d27a8915f468",
      "datasetType": "PHYSICAL_DATASET",
      "datasetPath": [
        "Samples (9)",
        "samples.dremio.com",
        "Dremio University",
        "airbnb_listings.csv"
      ],
      "canView": true,
      "canAlter": true,
      "entityType": "reflection-summary"
    }
  ]
}

Response Status Codes​

{{< api-responses file="data/software-api/reflection.json" data="retrieveReflectionSummary23ResponseCodes" >}}