# Get details of a player campaign state

**POST /free-spins-campaigns/get-player-state**

Get details of a player campaign state, this endpoint is rate limited to 10 requests per second.


## Servers
- BASE_URL: BASE_URL ()



## Parameters
### Headers
- **Signature** (string)

- **Public-Key** (string)




### Body: application/json (object)

- **brandId** (string)

- **campaignId** (string)

- **playerId** (string)



## Responses
### 200
Successful response

#### Body: application/json (object)
- **betCount** (integer(int32))
  Total bet count for the player in the campaign
- **betValue** (number)
  The bet value the campaign freespins are offered to the player
- **betsPlayed** (integer(int32))
  Current number of bets played for the player in the campaign
- **campaignId** (string)
  A campaign ID that was provided during creation
- **campaignName** (string)
  Non blank campaign name
- **consumeBefore** (integer(int64))
  [Unix epoch](https://en.wikipedia.org/wiki/Unix_time) time in milliseconds. Must be in the future. Consume before is considered to be hard end date, after which the campaign should be expired.
- **currency** (string)
  Non blank currency
- **gameId** (string)
  Non blank game ID
- **handoverAfter** (integer(int64))
  [Unix epoch](https://en.wikipedia.org/wiki/Unix_time) time in milliseconds. Start date of the campaign. Must be in the future.
- **status** (string)
  Current status for the player campaign
- **totalBetAmount** (number)
  Current total bet amount for the player in the campaign
- **totalWinAmount** (number)
  Current total win amount for the player in the campaign

### 400
Request could not be processed

#### Body: application/json (object)
- **code** (string)

- **description** (string)
  Message describing the error
- **traceId** (string)
  Internal ID to trace the request when debugging

### 401
Request public key or signature is missing or invalid

#### Body: application/json (object)
- **code** (string)

- **description** (string)
  Message describing the error
- **traceId** (string)
  Internal ID to trace the request when debugging

### 500
Internal error / Unknown error

#### Body: application/json (object)
- **code** (string)

- **description** (string)
  Message describing the error
- **traceId** (string)
  Internal ID to trace the request when debugging


[Powered by Bump.sh](https://bump.sh)