List report syncs
- OpenAPI 3.1.0 document: https://api.rollstack.com/public/v1/openapi.json
- The whole reference in Markdown: https://docs.rollstack.com/llms-full.txt
- An index of the reference: https://docs.rollstack.com/llms.txt
GET https://api.rollstack.com/public/v1/reports/{id}/syncs
The syncs of a report other than a SlideDeck, such as a Google Slides presentation or an email report: each chart, table or text it pulls from a source, with how it did the last time it updated and why it failed. Pass the failed ones' ids as syncIds to startReportRun to update only those. A SlideDeck report has datasheets instead and returns 400.
Requires the slide_decks:read scope.
Operation ID: listReportSyncs.
Path parameters
id(string, required): The report to act on, of anytype, by itsidfromlistReportsorcreateReport. You can also copy it from the report's link in Rollstack (appUrl): it's the part right after/slides/or/destinations/.
Response 200
Success
application/json: array of object
id(string, required): Unique identifier for the sync. Pass it insyncIdstostartReportRunto update only some syncs, or toupdateReportSchedulesfor a schedule that updates only some.name(string, required): The sync's name, as shown in the report's Syncs tab in Rollstack.sourceType(string, required): Where the sync gets its data, such asTableau,LookerorGoogleSheets. One ofGoogleSheet,GoogleExcel,MicrosoftExcel,Tableau,Salesforce,Metabase,PowerBI,Looker,RollstackVariable,Lightdash,Omni,Sigma,Snowflake,Databricks,BigQuery,CsvUpload,XlsxUpload,ManualTable,Dbt.status(string, required): How the sync did the last time it updated:succeeded,partiallySucceededorfailed.draftfor a sync that hasn't updated yet,activewhile it updates, andinactivewhen a check before the run stopped it, such as a source the owner can no longer reach. One ofactive,draft,succeeded,partiallySucceeded,failed,inactive.error(object or null, required): Why the last update failed or was stopped.nullwhen the sync succeeded or never updated.code(string or null, required): Why the sync failed, such asdashboard_not_found. One oftableau_view_not_found,dashboard_not_found,dashboard_tab_not_found,dashboard_not_ready,dashboard_has_errors,dashboard_invalid_layout,metabase_element_not_found,looker_element_not_found,element_not_found,google_slide_not_found,slide_not_found,file_not_found,sheet_not_found,sheet_hidden,range_not_found,duplicate_file_failed,merged_range_on_filter_range,insufficient_permissions,image_cropping_failed,visualization_not_found,visualization_not_ready,visualization_has_errors,visualization_empty,invalid_credentials,missing_credentials,instance_unavailable,column_not_found,empty_data,fetch_summary_data_error,fetch_visual_specification_error,incorrect_data_structure,missing_data,missing_formatted_value,malformed_data,viz_not_ready,worksheet_not_found,sync_not_found,file_update_failed,internal_server_error.details(string or null, required): More about the failure, as the app shows it.
slideIndex(number or null, required): Where the sync is in the file, as the 0-based index of its slide or page.nullwhen it has no fixed place, such as an email report.paused(boolean, required): Whether the sync is turned off, so runs skip it until it is turned on again in the app.lastSuccessfulUpdateAt(string (date-time) or null, required): When the sync last updated successfully.nullif it never has.