1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceSerpstat
airbyte 0.10.0 published on Monday, Apr 14, 2025 by airbytehq

airbyte.SourceSerpstat

Explore with Pulumi AI

SourceSerpstat Resource

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourceSerpstat;
import com.pulumi.airbyte.SourceSerpstatArgs;
import com.pulumi.airbyte.inputs.SourceSerpstatConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var mySourceSerpstat = new SourceSerpstat("mySourceSerpstat", SourceSerpstatArgs.builder()
            .configuration(SourceSerpstatConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .domain("...my_domain...")
                .domains("{ \"see\": \"documentation\" }")
                .filter_by("...my_filter_by...")
                .filter_value("...my_filter_value...")
                .page_size(0)
                .pages_to_fetch(5)
                .region_id("...my_region_id...")
                .sort_by("...my_sort_by...")
                .sort_value("...my_sort_value...")
                .build())
            .definitionId("d053b361-0135-4fe9-a99e-37ce6ddcd0f0")
            .secretId("...my_secret_id...")
            .workspaceId("5d8f700d-5d91-4270-a3d2-4196dea7e14e")
            .build());

    }
}
Copy
resources:
  mySourceSerpstat:
    type: airbyte:SourceSerpstat
    properties:
      configuration:
        api_key: '...my_api_key...'
        domain: '...my_domain...'
        domains:
          - '{ "see": "documentation" }'
        filter_by: '...my_filter_by...'
        filter_value: '...my_filter_value...'
        page_size: 0
        pages_to_fetch: 5
        region_id: '...my_region_id...'
        sort_by: '...my_sort_by...'
        sort_value: '...my_sort_value...'
      definitionId: d053b361-0135-4fe9-a99e-37ce6ddcd0f0
      secretId: '...my_secret_id...'
      workspaceId: 5d8f700d-5d91-4270-a3d2-4196dea7e14e
Copy

Create SourceSerpstat Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SourceSerpstat(name: string, args: SourceSerpstatArgs, opts?: CustomResourceOptions);
@overload
def SourceSerpstat(resource_name: str,
                   args: SourceSerpstatArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def SourceSerpstat(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   configuration: Optional[SourceSerpstatConfigurationArgs] = None,
                   workspace_id: Optional[str] = None,
                   definition_id: Optional[str] = None,
                   name: Optional[str] = None,
                   secret_id: Optional[str] = None)
func NewSourceSerpstat(ctx *Context, name string, args SourceSerpstatArgs, opts ...ResourceOption) (*SourceSerpstat, error)
public SourceSerpstat(string name, SourceSerpstatArgs args, CustomResourceOptions? opts = null)
public SourceSerpstat(String name, SourceSerpstatArgs args)
public SourceSerpstat(String name, SourceSerpstatArgs args, CustomResourceOptions options)
type: airbyte:SourceSerpstat
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SourceSerpstatArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SourceSerpstatArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SourceSerpstatArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SourceSerpstatArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SourceSerpstatArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var sourceSerpstatResource = new Airbyte.SourceSerpstat("sourceSerpstatResource", new()
{
    Configuration = new Airbyte.Inputs.SourceSerpstatConfigurationArgs
    {
        ApiKey = "string",
        Domain = "string",
        Domains = new[]
        {
            "string",
        },
        FilterBy = "string",
        FilterValue = "string",
        PageSize = 0,
        PagesToFetch = 0,
        RegionId = "string",
        SortBy = "string",
        SortValue = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceSerpstat(ctx, "sourceSerpstatResource", &airbyte.SourceSerpstatArgs{
Configuration: &.SourceSerpstatConfigurationArgs{
ApiKey: pulumi.String("string"),
Domain: pulumi.String("string"),
Domains: pulumi.StringArray{
pulumi.String("string"),
},
FilterBy: pulumi.String("string"),
FilterValue: pulumi.String("string"),
PageSize: pulumi.Float64(0),
PagesToFetch: pulumi.Float64(0),
RegionId: pulumi.String("string"),
SortBy: pulumi.String("string"),
SortValue: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
Copy
var sourceSerpstatResource = new SourceSerpstat("sourceSerpstatResource", SourceSerpstatArgs.builder()
    .configuration(SourceSerpstatConfigurationArgs.builder()
        .apiKey("string")
        .domain("string")
        .domains("string")
        .filterBy("string")
        .filterValue("string")
        .pageSize(0)
        .pagesToFetch(0)
        .regionId("string")
        .sortBy("string")
        .sortValue("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_serpstat_resource = airbyte.SourceSerpstat("sourceSerpstatResource",
    configuration={
        "api_key": "string",
        "domain": "string",
        "domains": ["string"],
        "filter_by": "string",
        "filter_value": "string",
        "page_size": 0,
        "pages_to_fetch": 0,
        "region_id": "string",
        "sort_by": "string",
        "sort_value": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceSerpstatResource = new airbyte.SourceSerpstat("sourceSerpstatResource", {
    configuration: {
        apiKey: "string",
        domain: "string",
        domains: ["string"],
        filterBy: "string",
        filterValue: "string",
        pageSize: 0,
        pagesToFetch: 0,
        regionId: "string",
        sortBy: "string",
        sortValue: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceSerpstat
properties:
    configuration:
        apiKey: string
        domain: string
        domains:
            - string
        filterBy: string
        filterValue: string
        pageSize: 0
        pagesToFetch: 0
        regionId: string
        sortBy: string
        sortValue: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

SourceSerpstat Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SourceSerpstat resource accepts the following input properties:

Configuration This property is required. SourceSerpstatConfiguration
WorkspaceId This property is required. string
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
Configuration This property is required. SourceSerpstatConfigurationArgs
WorkspaceId This property is required. string
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. SourceSerpstatConfiguration
workspaceId This property is required. String
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. SourceSerpstatConfiguration
workspaceId This property is required. string
definitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string
Name of the source e.g. dev-mysql-instance.
secretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. SourceSerpstatConfigurationArgs
workspace_id This property is required. str
definition_id str
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str
Name of the source e.g. dev-mysql-instance.
secret_id str
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. Property Map
workspaceId This property is required. String
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Outputs

All input properties are implicitly available as output properties. Additionally, the SourceSerpstat resource produces the following output properties:

CreatedAt double
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceSerpstatResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SourceId string
SourceType string
CreatedAt float64
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceSerpstatResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SourceId string
SourceType string
createdAt Double
id String
The provider-assigned unique ID for this managed resource.
resourceAllocation SourceSerpstatResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId String
sourceType String
createdAt number
id string
The provider-assigned unique ID for this managed resource.
resourceAllocation SourceSerpstatResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId string
sourceType string
created_at float
id str
The provider-assigned unique ID for this managed resource.
resource_allocation SourceSerpstatResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
source_id str
source_type str
createdAt Number
id String
The provider-assigned unique ID for this managed resource.
resourceAllocation Property Map
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId String
sourceType String

Look up Existing SourceSerpstat Resource

Get an existing SourceSerpstat resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SourceSerpstatState, opts?: CustomResourceOptions): SourceSerpstat
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceSerpstatConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[SourceSerpstatResourceAllocationArgs] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceSerpstat
func GetSourceSerpstat(ctx *Context, name string, id IDInput, state *SourceSerpstatState, opts ...ResourceOption) (*SourceSerpstat, error)
public static SourceSerpstat Get(string name, Input<string> id, SourceSerpstatState? state, CustomResourceOptions? opts = null)
public static SourceSerpstat get(String name, Output<String> id, SourceSerpstatState state, CustomResourceOptions options)
resources:  _:    type: airbyte:SourceSerpstat    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Configuration SourceSerpstatConfiguration
CreatedAt double
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
ResourceAllocation SourceSerpstatResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
Configuration SourceSerpstatConfigurationArgs
CreatedAt float64
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
ResourceAllocation SourceSerpstatResourceAllocationArgs
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
configuration SourceSerpstatConfiguration
createdAt Double
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
resourceAllocation SourceSerpstatResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String
configuration SourceSerpstatConfiguration
createdAt number
definitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string
Name of the source e.g. dev-mysql-instance.
resourceAllocation SourceSerpstatResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string
configuration SourceSerpstatConfigurationArgs
created_at float
definition_id str
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str
Name of the source e.g. dev-mysql-instance.
resource_allocation SourceSerpstatResourceAllocationArgs
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secret_id str
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
source_id str
source_type str
workspace_id str
configuration Property Map
createdAt Number
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
resourceAllocation Property Map
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourceSerpstatConfiguration
, SourceSerpstatConfigurationArgs

ApiKey This property is required. string
Serpstat API key can be found here: https://serpstat.com/users/profile/
Domain string
The domain name to get data for (ex. serpstat.com). Default: "serpstat.com"
Domains List<string>
The list of domains that will be used in streams that support batch operations
FilterBy string
The field name by which the results should be filtered. Filtering the results will result in fewer API credits spent. Each stream has different filtering options. See https://serpstat.com/api/ for more details.
FilterValue string
The value of the field to filter by. Each stream has different filtering options. See https://serpstat.com/api/ for more details.
PageSize double
The number of data rows per page to be returned. Each data row can contain multiple data points. The max value is 1000. Reducing the size of the page will result in fewer API credits spent. Default: 10
PagesToFetch double
The number of pages that should be fetched. All results will be obtained if left blank. Reducing the number of pages will result in fewer API credits spent. Default: 1
RegionId string
The ID of a region to get data from in the form of a two-letter country code prepended with the g_ prefix. See the list of supported region IDs here: https://serpstat.com/api/664-request-parameters-v4/. Default: "g_us"
SortBy string
The field name by which the results should be sorted. Each stream has different sorting options. See https://serpstat.com/api/ for more details.
SortValue string
The value of the field to sort by. Each stream has different sorting options. See https://serpstat.com/api/ for more details.
ApiKey This property is required. string
Serpstat API key can be found here: https://serpstat.com/users/profile/
Domain string
The domain name to get data for (ex. serpstat.com). Default: "serpstat.com"
Domains []string
The list of domains that will be used in streams that support batch operations
FilterBy string
The field name by which the results should be filtered. Filtering the results will result in fewer API credits spent. Each stream has different filtering options. See https://serpstat.com/api/ for more details.
FilterValue string
The value of the field to filter by. Each stream has different filtering options. See https://serpstat.com/api/ for more details.
PageSize float64
The number of data rows per page to be returned. Each data row can contain multiple data points. The max value is 1000. Reducing the size of the page will result in fewer API credits spent. Default: 10
PagesToFetch float64
The number of pages that should be fetched. All results will be obtained if left blank. Reducing the number of pages will result in fewer API credits spent. Default: 1
RegionId string
The ID of a region to get data from in the form of a two-letter country code prepended with the g_ prefix. See the list of supported region IDs here: https://serpstat.com/api/664-request-parameters-v4/. Default: "g_us"
SortBy string
The field name by which the results should be sorted. Each stream has different sorting options. See https://serpstat.com/api/ for more details.
SortValue string
The value of the field to sort by. Each stream has different sorting options. See https://serpstat.com/api/ for more details.
apiKey This property is required. String
Serpstat API key can be found here: https://serpstat.com/users/profile/
domain String
The domain name to get data for (ex. serpstat.com). Default: "serpstat.com"
domains List<String>
The list of domains that will be used in streams that support batch operations
filterBy String
The field name by which the results should be filtered. Filtering the results will result in fewer API credits spent. Each stream has different filtering options. See https://serpstat.com/api/ for more details.
filterValue String
The value of the field to filter by. Each stream has different filtering options. See https://serpstat.com/api/ for more details.
pageSize Double
The number of data rows per page to be returned. Each data row can contain multiple data points. The max value is 1000. Reducing the size of the page will result in fewer API credits spent. Default: 10
pagesToFetch Double
The number of pages that should be fetched. All results will be obtained if left blank. Reducing the number of pages will result in fewer API credits spent. Default: 1
regionId String
The ID of a region to get data from in the form of a two-letter country code prepended with the g_ prefix. See the list of supported region IDs here: https://serpstat.com/api/664-request-parameters-v4/. Default: "g_us"
sortBy String
The field name by which the results should be sorted. Each stream has different sorting options. See https://serpstat.com/api/ for more details.
sortValue String
The value of the field to sort by. Each stream has different sorting options. See https://serpstat.com/api/ for more details.
apiKey This property is required. string
Serpstat API key can be found here: https://serpstat.com/users/profile/
domain string
The domain name to get data for (ex. serpstat.com). Default: "serpstat.com"
domains string[]
The list of domains that will be used in streams that support batch operations
filterBy string
The field name by which the results should be filtered. Filtering the results will result in fewer API credits spent. Each stream has different filtering options. See https://serpstat.com/api/ for more details.
filterValue string
The value of the field to filter by. Each stream has different filtering options. See https://serpstat.com/api/ for more details.
pageSize number
The number of data rows per page to be returned. Each data row can contain multiple data points. The max value is 1000. Reducing the size of the page will result in fewer API credits spent. Default: 10
pagesToFetch number
The number of pages that should be fetched. All results will be obtained if left blank. Reducing the number of pages will result in fewer API credits spent. Default: 1
regionId string
The ID of a region to get data from in the form of a two-letter country code prepended with the g_ prefix. See the list of supported region IDs here: https://serpstat.com/api/664-request-parameters-v4/. Default: "g_us"
sortBy string
The field name by which the results should be sorted. Each stream has different sorting options. See https://serpstat.com/api/ for more details.
sortValue string
The value of the field to sort by. Each stream has different sorting options. See https://serpstat.com/api/ for more details.
api_key This property is required. str
Serpstat API key can be found here: https://serpstat.com/users/profile/
domain str
The domain name to get data for (ex. serpstat.com). Default: "serpstat.com"
domains Sequence[str]
The list of domains that will be used in streams that support batch operations
filter_by str
The field name by which the results should be filtered. Filtering the results will result in fewer API credits spent. Each stream has different filtering options. See https://serpstat.com/api/ for more details.
filter_value str
The value of the field to filter by. Each stream has different filtering options. See https://serpstat.com/api/ for more details.
page_size float
The number of data rows per page to be returned. Each data row can contain multiple data points. The max value is 1000. Reducing the size of the page will result in fewer API credits spent. Default: 10
pages_to_fetch float
The number of pages that should be fetched. All results will be obtained if left blank. Reducing the number of pages will result in fewer API credits spent. Default: 1
region_id str
The ID of a region to get data from in the form of a two-letter country code prepended with the g_ prefix. See the list of supported region IDs here: https://serpstat.com/api/664-request-parameters-v4/. Default: "g_us"
sort_by str
The field name by which the results should be sorted. Each stream has different sorting options. See https://serpstat.com/api/ for more details.
sort_value str
The value of the field to sort by. Each stream has different sorting options. See https://serpstat.com/api/ for more details.
apiKey This property is required. String
Serpstat API key can be found here: https://serpstat.com/users/profile/
domain String
The domain name to get data for (ex. serpstat.com). Default: "serpstat.com"
domains List<String>
The list of domains that will be used in streams that support batch operations
filterBy String
The field name by which the results should be filtered. Filtering the results will result in fewer API credits spent. Each stream has different filtering options. See https://serpstat.com/api/ for more details.
filterValue String
The value of the field to filter by. Each stream has different filtering options. See https://serpstat.com/api/ for more details.
pageSize Number
The number of data rows per page to be returned. Each data row can contain multiple data points. The max value is 1000. Reducing the size of the page will result in fewer API credits spent. Default: 10
pagesToFetch Number
The number of pages that should be fetched. All results will be obtained if left blank. Reducing the number of pages will result in fewer API credits spent. Default: 1
regionId String
The ID of a region to get data from in the form of a two-letter country code prepended with the g_ prefix. See the list of supported region IDs here: https://serpstat.com/api/664-request-parameters-v4/. Default: "g_us"
sortBy String
The field name by which the results should be sorted. Each stream has different sorting options. See https://serpstat.com/api/ for more details.
sortValue String
The value of the field to sort by. Each stream has different sorting options. See https://serpstat.com/api/ for more details.

SourceSerpstatResourceAllocation
, SourceSerpstatResourceAllocationArgs

Default SourceSerpstatResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics List<SourceSerpstatResourceAllocationJobSpecific>
Default SourceSerpstatResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics []SourceSerpstatResourceAllocationJobSpecific
default_ SourceSerpstatResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<SourceSerpstatResourceAllocationJobSpecific>
default SourceSerpstatResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics SourceSerpstatResourceAllocationJobSpecific[]
default SourceSerpstatResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
job_specifics Sequence[SourceSerpstatResourceAllocationJobSpecific]
default Property Map
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<Property Map>

SourceSerpstatResourceAllocationDefault
, SourceSerpstatResourceAllocationDefaultArgs

SourceSerpstatResourceAllocationJobSpecific
, SourceSerpstatResourceAllocationJobSpecificArgs

JobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements SourceSerpstatResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
JobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements SourceSerpstatResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
jobType String
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements SourceSerpstatResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
jobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements SourceSerpstatResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
job_type str
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resource_requirements SourceSerpstatResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
jobType String
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements Property Map
optional resource requirements to run workers (blank for unbounded allocations)

SourceSerpstatResourceAllocationJobSpecificResourceRequirements
, SourceSerpstatResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceSerpstat:SourceSerpstat my_airbyte_source_serpstat ""
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
airbyte airbytehq/terraform-provider-airbyte
License
Notes
This Pulumi package is based on the airbyte Terraform Provider.