Get publisher states
GET/api/v2/presence/publisher-states
Get publisher states
Request
Query Parameters
Possible values: >= 1
and <= 100
Default value: 5
Number of items to return per page. Currently limited to 100.
List of requested publisher names
Page requested
Filter by business ids
Responses
- 200
- 400
- 401
- 403
- 404
- 422
- 500
Method to retrieve businesses diffusions states on publishers.
Can be filtered by:
-
Business IDs
-
Publishers
-
States
- application/json
- Schema
- Example (from schema)
Schema
businesses
object
required
Maps business ids to their presence states
property name*
PresenceBusiness
publishers
object
Maps publisher names to their presence states
property name*
PresencePublishers
Possible values: [PUBLISHER_CONNEXION
, USER_INPUT
, EXTERNAL
, ADMIN_INPUT
]
Business id
{
"businesses": {}
}
- application/json
- Schema
- Example (from schema)
Schema
HTTP status code
Error message
Error name
{
"statusCode": 404,
"message": "Cannot find item",
"error": "Not Found"
}
- application/json
- Schema
- Example (from schema)
Schema
HTTP status code
Error message
Error name
{
"statusCode": 404,
"message": "Cannot find item",
"error": "Not Found"
}
- application/json
- Schema
- Example (from schema)
Schema
HTTP status code
Error message
Error name
{
"statusCode": 404,
"message": "Cannot find item",
"error": "Not Found"
}
- application/json
- Schema
- Example (from schema)
Schema
HTTP status code
Error message
Error name
{
"statusCode": 404,
"message": "Cannot find item",
"error": "Not Found"
}
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
HTTP status code
Error message
errors
object[]
required
Possible values: non-empty
Path to the property with the error
errors
object[]
required
Possible values: non-empty
Error type
Error message
{
"statusCode": 404,
"message": "Cannot find item",
"errors": [
{
"path": "business.id",
"errors": [
{
"type": "object_required_property",
"message": "Required property"
}
]
}
]
}
- application/json
- Schema
- Example (from schema)
Schema
HTTP status code
Error message
Error name
{
"statusCode": 404,
"message": "Cannot find item",
"error": "Not Found"
}