Develop with Looker Studio Linking API

Key Concepts

• Looker Studio Linking API
• Report Templates
• Query Parameters (Control, Report, Data Source)
• Data Source Aliases
• BigQuery Connector Parameters

Looker Studio Linking API: Introduction

The Looker Studio Linking API is a reliable interface for programmatically creating customized Looker Studio reports based on stakeholder needs. It allows for the creation of personalized reports with a single click, simplifying the report generation process and enabling multi-report creation at scale.

Use Cases

• One-Click Report Creation: Simplifies report creation for stakeholders, eliminating the need for manual report building.
• Multi-Report Creation at Scale: Enables programmatic creation or duplication of reports without manual intervention.
• Application Workflow Integration: Allows for the autogeneration of reports within existing application workflows.

Building a Linking API URL

The process involves using an existing Looker Studio report as a template. The URL consists of a base URL and query parameters.

Base URL

The base URL is the foundation of every Linking API URL: https://lookerstudio.google.com/reporting/create

Query Parameters

Query parameters configure the generated report. There are three types:

1. Control Query Parameters: Control the state of the generated report. Prefixed with c..
   • c.reportId: Specifies the Looker Studio report to use as a template. The report ID is found in the report's URL.
   • c.page: Specifies the page to land on first in the generated report.
2. Report Query Parameters: Set properties on the generated report. Prefixed with r..
   • r.reportName: Sets the name of the generated report.
   • r.measurementId and r.key: Enable Google Analytics to track report usage.
3. Data Source Query Parameters: Configure the data source in the generated report. Prefixed with ds<alias>., where <alias> is the data source alias.
   • refreshFields: If true, checks for schema changes and updates the data source fields.
   • connector: If set, replaces the original data source with the configured data source. If not set, the original data source is preserved and updated.

Data Source Query Parameters: BigQuery Example

Specific data source query parameters exist for each connector. For BigQuery:

• type: Configures the BigQuery data source to pull data from a table (table value) or a SQL query (customQuery value).
• sql: Defines the SQL query to pull data and fields.
• sqlReplace: Selectively updates the template's data source's original query.

Example Scenario

Imagine an organization using Looker Studio reports to visualize data from Google Analytics, tracking metrics across multiple product features. Each stakeholder needs a report specific to their product feature. The Linking API allows creating a template report and then generating customized reports for each stakeholder by modifying the query parameters, specifically the data source parameters to filter data for their specific product feature.

Conclusion

The Looker Studio Linking API provides a powerful way to programmatically generate customized reports at scale. By understanding the base URL, query parameters (control, report, and data source), and data source aliases, developers can create tailored reporting experiences for their stakeholders. The BigQuery example demonstrates the flexibility of the API in configuring data sources.

Next Steps

1. Create a Looker Studio report.
2. Generate a report from it using the Linking API URL.
3. Consider creating a template report and submitting it to the public gallery.