Recurly Query Component

Recurly Query

This component uses the Recurly API to retrieve data and store it on S3, where it is referenced by an External Table. You can then use transformations to enrich and manage the data.

Note:This component may return structured data that requires flattening. Please see the Nested Data Load Component for information on how to accomplish this.

Properties

Note: The properties displayed by the component are dependent on the selected Data Source. A complete list of properties is given below.

Property Setting Description
Name Text The descriptive name for the component.
Data Sources Select Select a Data Source.
API Key Text or Select The working API key used to connect to Recurly. For more information, please visit our support site's Recurly API Key documentation.
Subdomain Text The subdomain of your Recurly account, for example:
https://<subdomain>.recurly.com/v2/accounts
State Select Select the state of the Account, Coupons, Invoices, Subscriptions, Transactions, or other as per your chosen Data Source.
Note: The options that are available for selection in this parameter vary depending on your chosen Data Source.
Begin Time Datetime Operates on the attribute specified by the 'Sort' parameter. Filters data records to only include those with datetimes greater than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.
End Time Datetime Operates on the attribute specified by the 'Sort' parameter. Filters data records to only include those with datetimes less than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.
Account Code String A unique identifier used by Matillion ETL to identify the Recurly account. This string may contain the following characters: [a-z 0-9 @-_.]. For more information, please visit the Recurly documentation.
Invoice Code Integer The number of the invoice.
Subscription Code String The code used to identify the subscription. This string may contain the following characters: [a-z 0-9].
Plan Code String The unique code to identify the specific plan.
Type Select Select the type of transaction.
Page Limit Integer Set the page limit for the amount of records to be returned and staged.
Location Text/Select Provide an S3 Bucket path that will be used to store the data. Once on an S3 bucket, the data can be referenced by an external table. A folder will be created at this location with the same name as the Target Table.
External Schema Select Select the table's external schema. To learn more about external schemas, please consult the 'Configuring The Matillion ETL Client' section of the Getting Started With Amazon Redshift Spectrum documentation. The special value, [Environment Default] will use the schema defined in the environment. For more information on using multiple schemas, see Schema Support.
Target Table Text Provide a new table name.
Warning: This table will be recreated and will drop any existing table of the same name.