UserBonusCreateBatchOperation

toloka.client.operations.UserBonusCreateBatchOperation | Source code

UserBonusCreateBatchOperation(
self,
*,
id: Optional[str] = None,
status: Union[Operation.Status, str, None] = None,
submitted: Optional[datetime] = None,
started: Optional[datetime] = None,
finished: Optional[datetime] = None,
progress: Optional[int] = None,
parameters: Optional[Parameters] = None,
details: Optional[Details] = None
)

Operation returned by the TolokaClient.create_user_bonuses_async() method.

All parameters are for reference only and describe the initial parameters of the request that this operation monitors.

Parameters Description

ParametersTypeDescription
idOptional[str]

Operation ID.

statusOptional[Operation.Status]

The status of the operation.

submittedOptional[datetime]

The UTC date and time the request was sent.

startedOptional[datetime]

The UTC date and time the operation started.

finishedOptional[datetime]

The UTC date and time the operation finished.

progressOptional[int]

The percentage of the operation completed.

parametersOptional[Parameters]

Operation parameters (depending on the operation type).

detailsOptional[Details]

Details of the operation completion.

skip_invalid_items-

Validation parameters for JSON objects:

  • True — Create rewards using UserBonus instances that passed validation. Skip the rest of the UserBonus instances.
  • False — If at least one of the UserBonus instances didn't pass validation, stop the operation and don't create any rewards.
pool_id-
total_count-

The number of bonuses in the request.

valid_count-

The number of JSON objects with bonus information that have passed validation.

not_valid_count-

The number of JSON objects with bonus information that failed validation.

success_count-

Number of bonuses issued.

failed_count-

The number of bonuses that were not issued.

Toloka-Kit
OverviewGetting OAuth tokenQuick start
Recipes
Reference
toloka.client
toloka.async_client
toloka.autoquality [autoquality]
toloka.metrics
toloka.streaming