Piano Analytics icon

Piano Analytics

Use the Piano Analytics API
Join our community

Actions6

Overview

This node integrates with the Piano Analytics API, specifically supporting multiple resources including the Extraction API. For the Extraction API resource and the Get Total operation, it retrieves total values for each metric based on specified query parameters such as sites, columns, and period.

This is useful when you want to obtain aggregated totals of analytics metrics from Piano Analytics without fetching detailed row data. For example, a marketing analyst might use this node to quickly get total page views or conversions across multiple websites over a given time period.

Properties

Name Meaning
Sites Comma-separated list of site IDs (numbers) to query data for.
Columns Comma-separated list of metric columns to retrieve totals for.
Period JSON object defining the time period for the query (e.g., start and end dates).
Optional Parameters Collection of optional JSON parameters to refine the query:
- Evolution JSON object specifying evolution parameters (e.g., comparison periods).
- Filter JSON object to filter the data further.
- Options Additional JSON options for the query.
- Segment JSON object defining segments to apply to the data.

Output

The output is a JSON array where each item contains the total values for the requested metrics. The exact structure depends on the response from the Piano Analytics API but generally includes key-value pairs representing metric names and their total values.

No binary data output is produced by this operation.

Example output snippet:

[
  {
    "metric1": 12345,
    "metric2": 67890,
    ...
  }
]

Dependencies

  • Requires an API key credential for Piano Analytics with accessKey and secretKey.
  • The node makes HTTP POST requests to https://api.atinternet.io/v3/data/getTotal.
  • No additional environment variables are required beyond the API credentials.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not set or invalid, the node will throw an error indicating missing credentials.
  • Required Parameter Errors: The node validates that Sites, Columns, and Period are provided; missing any of these will cause an error.
  • Invalid JSON in Parameters: Optional parameters must be valid JSON; malformed JSON will cause parsing errors.
  • API Request Failures: Network issues or invalid API keys can cause request failures. Check your API key validity and network connectivity.
  • Unknown Operation or Resource: Using unsupported operations or resources will result in an error.

Links and References

Discussion