Page Size
This parameter defines the page size during the API request (number of records).
Technical Name |
page_size |
Category |
Technical |
Type |
Number |
Default Value |
100 |
Example Values |
100 |
It is recommended to change this value only if there are connection issues or rate limitation. Otherwise changing this parameter should not be necessary. The larger the page size, the longer a request will take. On the other hand, a high page size will decrease the total number necessary requests.
|
Be aware: Most APIs will limit the maximum page size! |
Usage Request Interval
This parameter contains the duration of the interval per request. The parameter uses the ISO 8601 format.
Technical Name |
sign_ins_request_interval |
Category |
Technical |
Type |
String |
Default Value |
PT12h |
Example Values |
PT24h, PT2d |
To speed up the download of the sign-ins, the requests are executed in parallel. For example: if Sign-ins Since is PT10h and Sign-ins Request Interval is PT2h there will be five parallel requests. A shorter interval always means more parallel requests, which means the complete time will be reduced, unless the high parallelization leads to the API's refusal to answer the requests. Thus, the optimal value for this parameter is unknown.
Initial Delay (in ms)
This parameter defines the initial time (in milliseconds) to wait before a failed request is reattempted.
Technical Name |
initial_delay |
Category |
Technical |
Type |
Number |
Default Value |
1000 |
Example Values |
1000 |
When a request fails, the connector does a so-called exponential backoff. The delay starts with this duration and then exponentially increases with every failed attempt.
Maximum Delay (in ms)
This parameter the maximum amount of time (in milliseconds) to wait before a failed HTTP request is reattempted. Set to null for unrestricted delay.
Technical Name |
max_delay |
Category |
Technical |
Type |
Number null |
Default Value |
600000 |
Example Values |
600000 |
When a request fails, the connector does a so-called exponential backoff. The delay increases with every failed attempt up to this duration. In order to limit the total runtime of the connector, one can set a maximum delay.
Maximum Number of Attempts
This parameter represents the maximum number of attempts after which an HTTP request will fail permanently.
Technical Name |
max_attempts |
Category |
Technical |
Type |
Number |
Default Value |
3 |
Example Values |
3 |
Failed requests will be resend by the connector before failing the whole connector run. When experiencing a lot of connectivity issues which are not related to server overload or some kind of rate limitation, it is recommended to increase this parameter as well as the Timeout and the Maximum Delay parameter.
Connection Timeout (in ms)
This parameter defines the time (in milliseconds) after which a running request aborts. If set to null, the default timeout of the system is used.
Technical Name |
timeout |
Category |
Technical |
Type |
Number |
Default Value |
0 |
Example Values |
0, 10000 |