iTwin Component Center icon

iTwin Component Center

Comprehensive iTwin Component Center API

Actions58

Overview

This node interacts with the iTwin Component Center API to retrieve analytics data related to downloads. Specifically, the "Download Analytics" operation fetches download statistics within a specified date range. This is useful for users who want to analyze usage patterns, monitor component popularity, or generate reports on download activity over time.

Practical examples include:

  • Tracking how many times components were downloaded between two dates.
  • Generating analytics reports for project stakeholders.
  • Monitoring trends in component usage to inform development priorities.

Properties

Name Meaning
Start Date The start datetime for the analytics query. Must be in the format yyyy-MM-dd'T'HH:mm:ss.fff'Z'. Specifies the beginning of the period for which download analytics are returned.
End Date The end datetime for the analytics query. Must be in the format yyyy-MM-dd'T'HH:mm:ss.fff'Z'. Specifies the end of the period for which download analytics are returned.

Output

The node outputs JSON data representing the download analytics retrieved from the iTwin Component Center API. Each output item contains analytics information corresponding to the requested date range. The exact structure depends on the API response but generally includes metrics such as counts and timestamps related to downloads.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API key credential for authenticating with the iTwin Component Center API.
  • The node uses an internal interpreter module (ComponentCenterOpenApiInterpreter) to handle API operations.
  • Proper configuration of the API credentials in n8n is necessary for successful execution.

Troubleshooting

  • Common issues:

    • Invalid date format for Start Date or End Date will likely cause API errors. Ensure the datetime strings strictly follow the required ISO 8601 format with milliseconds and 'Z' suffix.
    • Missing or incorrect API authentication credentials will result in authorization failures.
    • Requesting analytics for a date range where no data exists may return empty results.

  • Error messages:

    • "Unknown operation: <operation>" indicates that the specified operation name is not recognized by the node. Verify that "download-analytics" is correctly set.
    • API errors related to invalid parameters or authentication will be surfaced; check credentials and input values.
    • If the node is configured to continue on failure, error details will be included in the output JSON under an error field.

Links and References

Discussion