Serpstat
This page contains the setup guide and reference information for the Serpstat source connector.
Setup guide
Step 1: Get Serpstat API key
For new Serpstat users
- Create a new Serpstat account.
- Go to My account page and click Get API key.
- Follow the instructions to get the API key.
- Click Copy to copy the API key.
For existing Serpstat users
Go to My account page and click Copy to copy the API key.
Step 2: Set up the Serpstat connector in Airbyte
- Log into your Airbyte Cloud or Airbyte Open Source account.
- Click Sources and then click + New source.
- On the Set up the source page, select Serpstat from the Source type dropdown.
- Enter a name for your connector.
- Enter the API key.
- Expand Optional fields and fill them in. Each API response consumes API credits available to your Serpstat subscription plan. To limit the number of consumed API rows, decrease Page size and Pages to fetch options.
- Click Set up source.
Supported sync modes
The Serpstat source connector supports the following sync modes:
- Full refresh
Supported Streams
- Domains summary
- Domain history
- Domain keywords
- Domain keywords by region
- Domain competitors
- Domain top pages
Performance considerations
The maximum sync speed is limited by the number of requests per second per API key. See this limit in your Serpstat account.
Reference
Config fields reference
Field
Type
Property name
string
api_key
string
domain
integer
page_size
array
domains
string
filter_by
string
filter_value
string
sort_by
string
sort_value
integer
pages_to_fetch
string
region_id
Changelog
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 0.1.0 | 2023-08-21 | 28147 | Release Serpstat Connector |