Task Parameters

<< Click to Display Table of Contents >>

Raynet One Data Hub > 14.0 > Connectors > Alphabetic Connector List > Microsoft Graph Generic Query > Connector Parameters 

Task Parameters

Page Size

This parameter defines the page size during the API request (number of records).

 

Technical Name

page_size

Category

Technical

Type

Integer

Default Value

999

Example Values

999

 

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.

 

finger1

Be aware:

Most APIs will limit the maximum page size!

 

Rate Limiter Number of Requests

This parameter limits the number of requests issued in the time interval set by the parameter Rate LImiter Duration.

 

Technical Name

rate_limiter_num_requests

Category

Technical

Type

Integer

Default Value

5

Example Values

5, 20

 

The rate limiter ensures that at most Rate Limiter Number of Requests are issued in a Rate Limiter Duration. If requests fail with a "too many requests" error, study the API documentation and adapt those parameters accordingly. The API has a globale maximum of 2000 requests per second maximum. In practice, the real maximum is much lower, about 5-50 requests per second.

 

Rate Limiter Duration

This parameter sets the time interval during which at most Rate Limiter Number of Requests are issued by the connector.

 

Technical Name

rate_limiter_duration

Category

Technical

Type

String

Default Value

PT1S

Example Values

PT1S, PT1M, PT2H

 

The rate limiter ensures that at most Rate Limiter Number of Requests are issued in a Rate Limiter Duration. If requests fail with a "too many requests" error, study the API documentation and adapt those parameters accordingly. The API has a global maximum of 2000 requests per second maximum. In practice, the real maximum is much lower, about 5-50 requests per second.

 

Connection Timeout (in ms)

This parameter specifies the time after which a running request will be aborted. If set to null, the default timeout of the system will be used.

 

Technical Name

timeout

Category

Technical

Type

Integer

null

Default Value

null

Example Values

null, 10000

 

Initial Delay (in ms)

This parameter represents the initial time (in milliseconds) to wait before a failed request will be reattempted.

 

Technical Name

initial_delay

Category

Technical

Type

Integer

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 represents the maximum time (in milliseconds) to wait before an HTTP request that has been failed will be reattempted. If set to null, the delay will not be restricted.

 

Technical Name

max_delay

Category

Technical

Type

Integer

null

Default Value

3600000

Example Values

3600000

 

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, on 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

Integer

Default Value

5

Example Values

5

 

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.