Piano Analytics icon

Piano Analytics

Use the Piano Analytics API
Join our community

Actions6

Overview

This node integrates with the Piano Analytics Extraction API to retrieve fully processed analytics data. It allows users to query their analytics data by specifying sites, columns (metrics/dimensions), time periods, sorting, pagination, and optional filters or segments. This is useful for extracting detailed reports or datasets from Piano Analytics for further analysis, reporting, or integration into other workflows.

Typical use cases include:

  • Fetching custom analytics reports filtered by specific sites and date ranges.
  • Paginating through large datasets using max results and page number parameters.
  • Sorting data by one or more columns.
  • Applying advanced filters, segments, or options to refine the extracted data.

For example, a marketing analyst could use this node to pull daily visitor metrics for multiple websites over the last month, sorted by traffic volume, and then feed that data into a dashboard or spreadsheet.

Properties

Name Meaning
Sites Comma-separated list of site IDs to query data from.
Columns Comma-separated list of columns (metrics/dimensions) to retrieve in the query.
Period JSON object defining the time period for the query (e.g., start and end dates).
Sort By Comma-separated list of columns to sort the results by.
Max Results Maximum number of results to return per page (pagination limit).
Page Number The page number of results to retrieve (for pagination).
Optional Parameters Collection of optional JSON parameters to customize the query:
- Evolution JSON object specifying evolution parameters (e.g., comparison periods).
- Filter JSON object defining filters to apply on the data.
- Options JSON object for additional query options.
- Segment JSON object defining segments to apply to the data.

Output

The node outputs an array of JSON objects representing the queried data rows returned by the Piano Analytics Extraction API. Each object corresponds to a row of data containing the requested columns and their values.

If no data is returned, the output will contain a single object with a "Status Code": "204 No Content" field indicating an empty result set.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Piano Analytics API.
  • The node makes HTTP POST requests to the Piano Analytics endpoints:
    • https://api.atinternet.io/v3/data/getData for data retrieval.
    • Other endpoints for row count or totals if those operations are selected.
  • No additional external dependencies beyond standard HTTP request capabilities.

Troubleshooting

  • Missing Credentials: If the API credentials are not provided or invalid, the node throws an error "Missing Piano Analytics API Credentials". Ensure valid API keys are configured.
  • Required Parameters Missing: The node validates required fields like Columns, Period, and Sites. Omitting these will cause errors such as "Columns is required" or "Period is required".
  • Invalid JSON Inputs: Properties like Period and optional parameters expect valid JSON. Malformed JSON will cause parsing errors.
  • Unknown Operation or Resource: Selecting unsupported operations or resources will throw errors like "Unknown operation" or "Unknown resource".
  • API Errors: Any errors returned by the Piano Analytics API are wrapped and reported with the message prefix "Error calling Piano Analytics API".

To resolve issues:

  • Double-check all required input properties are set correctly.
  • Validate JSON inputs with a JSON validator before entering.
  • Confirm API credentials are correct and have necessary permissions.
  • Review error messages for hints on missing or invalid parameters.

Links and References

Discussion