Reports

Report API Reference

Retrieve all

get
Query parameters
projectIdstringOptional

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

folderIdstringOptional

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

limitstringOptional

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

Responses
200
List of report tabs
application/json
get
GET /api/v2/reports HTTP/1.1
Host: api_host
Accept: */*
200

List of report tabs

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

Retrieve

get
Path parameters
idstringRequired

reportTab id

Responses
200
Details about the report tab
application/json
get
GET /api/v2/reports/{id} HTTP/1.1
Host: api_host
Accept: */*
200

Details about the report tab

{
  "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

get
Path parameters
idstringRequired

reportTab id

Responses
200
Result in CSV format
text/csv
Responsestring
get
GET /api/v2/reports/{id}/download HTTP/1.1
Host: api_host
Accept: */*
200

Result in CSV format

text

Retreive latest success job details

get
Path parameters
idstringRequired

reportTab id

Responses
200
Details about the latest success job
application/json
get
GET /api/v2/reports/{id}/job/latestsuccess HTTP/1.1
Host: api_host
Accept: */*
200

Details about the latest success job

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

Last updated