This integration is powered by Singer's Darksky tap. For support, visit the GitHub repo or join the Singer Slack.
Darksky feature snapshot
A high-level look at Stitch's Darksky (v1) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release status |
Released on January 3, 2020 |
Supported by | |
Stitch plan |
Standard |
API availability |
Available |
Singer GitHub repository | |||
REPLICATION SETTINGS | |||
Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
DATA SELECTION | |||
Table selection |
Unsupported |
Column selection |
Unsupported |
Select all |
Unsupported |
||
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Darksky
Step 1: Retrieve your Darksky secret key
- Log into your Darksky API account here.
- On your account home page, your Secret Key is available at the top of the page. You will use this Secret Key to add your integration.
Step 2: Add Darksky as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Darksky icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Darksky” would create a schema called
stitch_darksky
in the destination. Note: Schema names cannot be changed after you save the integration. - In the Language field, enter the language code. Ex: ‘en’ for English, ‘es’ for Spanish, and ‘fr’ for French. For a full list of available language codes, check the
Request Parameters
section of the Darksky API documentation. - In the Location List field, enter the latitude and longitude of the the locations to be returned for weather forecast information. The locations must be semi-colon deliniated. Ex:
<latitude>,<longitude>
is an accepted value for a single location, and<latitude>,<longitude>;<latitude>,<longitude>; ... etc
is accepted for multiple locations. - In the Secret Key field, paste your Darksky secret key that you retrieved in Step 1.
- In the Units field, enter the measurement system to be returned for weather forecast information. Ex: ‘us’ for Imperial Units, and ‘si’ for International System of Units. For a full list of available measurement systems, check the
Request Parameters
section of the Dark Sky API documentation
Step 3: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Darksky integration. This means that data equal to or newer than this date will be replicated to your data warehouse.
Change this setting if you want to replicate data beyond Darksky’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 4: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Darksky integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Initial and historical replication jobs
After you finish setting up Darksky, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Darksky table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the Darksky integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
forecast
The forecasts
table contains weather conditions for a particular date and location. The locations are determined by the locations entered into the Locations field in Stitch.
Note: The units data points are returned in is determined by the value entered into the Units field in Stitch. For example: If us
is entered, data will be returned in Imperial units.
Key-based Incremental |
|
Primary Keys |
forecast_date latitude longitude |
Replication Key |
forecast_date |
Useful links |
daily OBJECT
|
|||||||||||||||||||||||||||||||||||||
end_time DATE-TIME |
|||||||||||||||||||||||||||||||||||||
flags OBJECT
|
|||||||||||||||||||||||||||||||||||||
forecast_date DATE-TIME |
|||||||||||||||||||||||||||||||||||||
hourly OBJECT
|
|||||||||||||||||||||||||||||||||||||
latitude NUMBER |
|||||||||||||||||||||||||||||||||||||
local_date STRING |
|||||||||||||||||||||||||||||||||||||
longitude NUMBER |
|||||||||||||||||||||||||||||||||||||
offset NUMBER |
|||||||||||||||||||||||||||||||||||||
start_time DATE-TIME |
|||||||||||||||||||||||||||||||||||||
timezone STRING |
Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.