Reports

Report API Reference

PreviousFolders

Last updated 1 year ago

Retrieve all

get

/reports

Query parameters

projectIdstring

The project Id from which to retrieve. If not given, then default project is used

folderIdstring

The folder Id acc. to which records will be retrieved. If not given, then all report tabs will be retrieved

limitstring

The number of records to retrieve. If not given, then by default 1000 report tabs will be fetched.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://API_HOST/api/v2/reports'

200

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

List of report tabs

Retrieve

get

/reports/{id}

Path parameters

idstringrequired

reportTab id

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://API_HOST/api/v2/reports/{id}'

200

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

Details about the report tab

Returns report tab result in csv format

get

/reports/{id}/download

Path parameters

idstringrequired

reportTab id

Responses

text/csv

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://API_HOST/api/v2/reports/{id}/download'

200

text

Result in CSV format

Retreive latest success job details

get

/reports/{id}/job/latestsuccess

Path parameters

idstringrequired

reportTab id

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://API_HOST/api/v2/reports/{id}/job/latestsuccess'

200

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

Details about the latest success job