Reports

Report API Reference

Retrieve all

GEThttps://API_HOST/api/v2/reports

Query parameters

Response

200

List of report tabs

Body

application/json

tabId*string

Example: "8aec2615e1c540d2b71129a3a9e5fdc3"

reportId*string

Example: "12f49087y1q509r5b6223881e9e77yt4"

type*string

Example: "MODEL"

tabName*string

Example: "Analysis 1"

reportName*string

Example: "order details"

owner*string

Example: "[email protected]"

folderId*string

Example: "6be53896a0604c0d817f638229f83ac9"

scheduled*boolean

Example: true

createTime*number

Example: 1660439099000

updateTime*number

Example: 1660445539000

Request

JavaScriptCurlPython

const response = await fetch('https://API_HOST/api/v2/reports', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "tabId": "8aec2615e1c540d2b71129a3a9e5fdc3",
    "reportId": "12f49087y1q509r5b6223881e9e77yt4",
    "type": "MODEL",
    "tabName": "Analysis 1",
    "reportName": "order details",
    "owner": "[email protected]",
    "folderId": "6be53896a0604c0d817f638229f83ac9",
    "scheduled": true,
    "createTime": 1660439099000,
    "updateTime": 1660445539000
  }
]

Retrieve

GEThttps://API_HOST/api/v2/reports/{id}

Path parameters

id*string

reportTab id

Response

200

Details about the report tab

Body

application/json

tabId*string

Example: "8aec2615e1c540d2b71129a3a9e5fdc3"

reportId*string

Example: "12f49087y1q509r5b6223881e9e77yt4"

type*string

Example: "MODEL"

tabName*string

Example: "Analysis 1"

reportName*string

Example: "order details"

owner*string

Example: "[email protected]"

folderId*string

Example: "6be53896a0604c0d817f638229f83ac9"

encodedSQL*string

Example: "l0V1RWN0ICd2aXNoYWwuYmhvb1e5ht7asgnb0HJpbmtsZWRhdJK9Y29tJywna2V5MjIyMicsJ3NlY3JldDIylicsMA=="

createTime*number

Example: 1660439099000

updateTime*number

Example: 1660445539000

Request

JavaScriptCurlPython

const response = await fetch('https://API_HOST/api/v2/reports/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "tabId": "8aec2615e1c540d2b71129a3a9e5fdc3",
  "reportId": "12f49087y1q509r5b6223881e9e77yt4",
  "type": "MODEL",
  "tabName": "Analysis 1",
  "reportName": "order details",
  "owner": "[email protected]",
  "folderId": "6be53896a0604c0d817f638229f83ac9",
  "encodedSQL": "l0V1RWN0ICd2aXNoYWwuYmhvb1e5ht7asgnb0HJpbmtsZWRhdJK9Y29tJywna2V5MjIyMicsJ3NlY3JldDIylicsMA==",
  "createTime": 1660439099000,
  "updateTime": 1660445539000
}

Returns report tab result in csv format

GEThttps://API_HOST/api/v2/reports/{id}/download

Path parameters

id*string

reportTab id

Response

200

Result in CSV format

Headers

Body

text/csv

string

Request

JavaScriptCurlPython

const response = await fetch('https://API_HOST/api/v2/reports/{id}/download', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

text

Retreive latest success job details

GEThttps://API_HOST/api/v2/reports/{id}/job/latestsuccess

Path parameters

id*string

reportTab id

Response

200

Details about the latest success job

Body

application/json

startTime*number

Example: 1660439099000

endTime*number

Example: 1660445539000

outputPath*string

Example: "gs://test-sprinkle-bucket/sprinkle/project/bigquery/queryoutput/b2f25da90155433dabf76225bc5ace1c"

Request

JavaScriptCurlPython

const response = await fetch('https://API_HOST/api/v2/reports/{id}/job/latestsuccess', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "startTime": 1660439099000,
  "endTime": 1660445539000,
  "outputPath": "gs://test-sprinkle-bucket/sprinkle/project/bigquery/queryoutput/b2f25da90155433dabf76225bc5ace1c"
}