Parth Mahida
10/18/2024, 12:39 PMuser
10/18/2024, 12:39 PM{{ variable_name }}
. For example, if you are using the Offset Increment pagination method, you can access the limit and offset parameters as follows: yaml Mode: Offset Increment Limit: 2 Inject limit into outgoing HTTP request: Inject into: request_parameter Field name: limit Inject offset into outgoing HTTP request: Inject into: request_parameter Field name: offset
In this case, the limit
and offset
are injected into the outgoing HTTP request as request parameters. The connector will automatically increment the offset
for subsequent requests based on the number of records it receives, and will continue until it receives fewer records than the limit you configured. For more complex cases where the API requires special handling (like adding a prefix or suffix to the actual value, or injecting the value into the URL path), you can disable injection and use the generic parameter section at the bottom of the stream configuration form to freely configure query parameters, headers, and properties of the JSON body. You can use Jinja expressions and available variables for this purpose. For example, if you need to inject the limit and after parameters into the URL path, you can use the next_page_token
variable like this: yaml Key: limit Value: {{ next_page_token['next_page_token'] or '0' }},50
This will inject the offset from the pagination strategy and a hardcoded limit of 50 into the same parameter. For more information, you can refer to the following documentation: - [Pagination in Connector Builder UI](https://docs.airbyte.com/connector-development/connector-builder-ui/pagination#offset-increment) - [Custom Parameter Injection](https://docs.airbyte.com/connector-development/connector-builder-ui/pagination#custom-parameter-injection) - [Understanding the YAML file](https://docs.airbyte.com/connector-development/config-based/understanding-the-yaml-file/reference/#/variables)