Get publisher states

GET 
/api/v2/presence/publisher-states

Method to retrieve businesses diffusions states on publishers.

Can be filtered by:

• Business IDs
• Publishers
• States

Request

Query Parameters

page integer

Possible values: >= 1

Default value: 1

Page of items to fetch

per_page integer

Possible values: >= 1

Number of items per page.

business__in string[]

Limit results to a specific businesses

publishers string[]
Limit results to a specific publisher
Example: [facebook, google_my_business]
states string[]
Possible values: [success, pending, to_configure]
Limit results to a specific states
Example: [success, pending]

Responses

200

application/json

Schema

Schema

businesses

object

Maps business ids to their presence states

property name*

object

business_id string

business_formatted_address string

business_name string

publishers

object

property name*

object

Maps publisher names to their presence states

error_type

object

anyOf

MOD1

string

Possible values: [PUBLISHER_CONNEXION, USER_INPUT, EXTERNAL]

state string

url_on_publisher

object

anyOf

MOD1

string

Example (from schema)

{
  "businesses": {}
}

400

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

401

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

403

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

404

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

422

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

location stringrequired

Possible values: [query, body, response, param]

Where in the request the error occurred

errors

object[]

required

Array [

path stringrequired

Possible values: non-empty

Path to the property with the error

constraints

object

required

property name* string

Error message

]

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "location": "query",
  "errors": [
    {
      "path": "business.id",
      "constraints": {
        "object_required_property": "Required property"
      }
    }
  ]
}

500

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

Loading...