GET /api/v202610/wattsreportdelivery/{deliveryId}/snapshot

Retrieves the frozen result data and grid state of one Watts report delivery for loading into the report grid

GetWattsReportDeliverySnapshotV202610

Use this endpoint to load the immutable result captured when the distribution ran; repeat reads return identical data even if the source report or underlying data has since changed. No file is generated: the user exports from the grid, and the returned report format is only the export option to preselect. Expiry and revocation are checked on every read. The response also carries the organization name and logo for exported files, because a public-link viewer cannot read system settings. A delivery that belongs to another recipient, is expired or revoked, or does not exist all return 404.

Request Headers

Header	Value	Required	Description
ECI-ApiKey	string	Yes	Your API key. See Authentication.
Content-Type	application/json	Yes	All requests must specify JSON content type.

Path Parameters

Name	Description	Type	Required
deliveryId	Unique numeric identifier of the per-recipient delivery, as carried by the emailed link.	integer (int32)	Required

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

WattsReportSnapshotResponse

Property Description Type

capturedAt The UTC time the result was captured. The data does not change after this moment. string (date-time)

deliveryId The unique numeric identifier of the per-recipient delivery this snapshot belongs to. integer (int32)

description The report description frozen at capture time. Null if the report had no description. string

organizationLogo The organization logo, as a base64-encoded image, to show in Excel files exported from the snapshot. Null if no logo is set or it could not be read. string

organizationName The organization name to show in the header rows of files exported from the snapshot. Null if it could not be read; exports then proceed without it. string

reportFormat The export option the viewer should preselect: CSV, CSV Data Only, or Excel. No file is generated by the server; the user exports from the grid. string

reportName The report title frozen when the snapshot was captured. string

result EdxQueryResultV202606

EdxQueryResultV202606 properties

Property Description Type

columns EdxColumnV202606[]

EdxColumnV202606 properties

Property Description Type

dataType The logical value type used by clients for formatting and data behavior. string

description Human-readable description of the column, when documented in the schema. string

name The result alias or schema field name displayed for this column. string

presentation EdxPresentationV202606

EdxPresentationV202606 properties

Property	Description	Type
entityType	Entity addressed by an `entityLink`, such as `place` or `meter`. Null for presentation formats that do not address an entity.	string
format	Presentation strategy: `entityLink` for an identifier that links to its entity, or `number` for a measure displayed with a specific number of decimal places.	string
fractionDigits	Decimal places to display for a `number` presentation, such as 3 for EUI. Null for other formats, in which case clients use their default precision.	integer (int32)

relatedFields Unit fields needed to display this field. EdxRelatedFieldV202606[]

EdxRelatedFieldV202606 properties

Property	Description	Type
name	Name of the related unit field.	string
type	Display role: `unit` or `unitCode`.	string

queryTimeMs integer (int64)

render EdxRenderV202606

EdxRenderV202606 properties

Property	Description	Type
accumulate	Optional running-total flag.	boolean
chartType	Chart kind: columnchart, barchart, timechart, linechart, areachart, piechart, scatterchart, etc.	string
kind	Optional sub-kind, e.g. “stacked”.	string
series	Optional series (split-by) columns.	string[]
title	Optional chart title.	string
xColumn	Optional explicit category (x-axis) column.	string
yColumns	Optional explicit value (y-axis) columns.	string[]

rowCount integer (int32)

rows Rows, each an array of cell values aligned positionally to EnergyCap.DTO.V202606.EdxQueryResultDTO.Columns. array[]

truncated True when results were capped and more rows exist. boolean

state The frozen grid and chart state as a JSON string (layout, filters, sorting, grouping, pivoting). Null if none was saved. string

Example Response application/json

{  "capturedAt": "2026-11-12",  "deliveryId": 1,  "description": "string",  "organizationLogo": "string",  "organizationName": "string",  "reportFormat": "string",  "reportName": "string",  "result": {    "columns": [
      {      "dataType": "string",      "description": "string",      "name": "string",      "presentation": {},      "relatedFields": []
    }
    ],    "queryTimeMs": 1,    "render": {      "accumulate": false,      "chartType": "string",      "kind": "string",      "series": [],      "title": "string",      "xColumn": "string",      "yColumns": []
    },    "rowCount": 1,    "rows": [
      [
      {}
    ]
    ],    "truncated": false
  },  "state": "string"
}

404 Not Found The requested resource was not found. Verify the ID or path is correct.