Reports

How to Use the Reports API

The Reports API provides programmatic access to manage and interact with Cloud Analytics reports. This guide will walk you through the key functionalities, including listing, creating, updating, deleting, and querying reports.

Key Endpoints

1. List Reports

• Endpoint: GET /analytics/v1/reports
• Purpose: Retrieve a list of all reports accessible to your account.
• Parameters:
  • maxResults: Maximum number of results per page.
  • pageToken: Token for pagination.
  • filter: Filter expression to narrow down results.

2. Create a Report

• Endpoint: POST /analytics/v1/reports
• Purpose: Create a new report.
• Request Body:
  • name: The name of the report.
  • description: A brief description of the report.
  • config: Configuration details, including metrics and filters.

3. Get Report Results

• Endpoint: GET /analytics/v1/reports/{id}
• Purpose: Retrieve the results of a specific report.
• Parameters:
  • timeRange: Override the report's time settings.
  • startDate and endDate: Specify a custom date range.

4. Update a Report

• Endpoint: PATCH /analytics/v1/reports/{id}
• Purpose: Update an existing report's configuration.
• Request Body: Include fields like name, description, or config to update.

5. Delete a Report

• Endpoint: DELETE /analytics/v1/reports/{id}
• Purpose: Remove a specific report.

6. Run a Query

• Endpoint: POST /analytics/v1/reports/query
• Purpose: Execute a report query with specified settings without saving it.
• Request Body:
  • config: Configuration for the query, including metrics and filters.

Authentication

Ensure you have the necessary API key or OAuth token to authenticate your requests.

Example Usage

• List Reports: Send a GET request to /analytics/v1/reports with optional parameters for filtering and pagination.
• Create a Report: Send a POST request to /analytics/v1/reports with a JSON body containing the report's details.

Tips

• Use filters to refine the list of reports based on specific criteria.
• Utilize pagination tokens to efficiently handle large datasets.
• Check response codes to manage errors effectively.

This guide provides a basic understanding of how to use the Reports API. For more detailed information, refer to the official API documentation.