Use this as a guide or a template for your tap's documentation. Remove a section if it's not applicable.
To set up [tap_name] in Stitch, you need:
For each requirement:
- The requirement. Brief explanation of the requirement. Include links to if relevant.
The steps necessary to set up the tap, including instructions for obtaining API credentials, configuring account settings, granting user permissions, etc. if necessary.
If pertinent, include details about how the tap replicates data and/or uses the API. As Stitch users are billed for total rows replicated, any info that can shed light on the number of rows replicated or reduce usage is considered necessary.
Examples:
- Replication strategy - attribution/conversion windows (Google AdWords), event-based updates, etc.
- API usage, especially for services that enforce rate limits or quotas, like Salesforce or Marketo
For each table that the tap produces, provide the following:
- Table name:
- Description:
- Primary key column(s):
- Replicated fully or incrementally (uses a bookmark to maintain state):
- Bookmark column(s): (if replicated incrementally)
- Link to API endpoint documentation:
Anything else users should know about using this tap? For example: some_column is a Unix timestamp.