Get publishers

GET 
/api/v2/presence/publishers

Retrieve a list of publishers available on the platform

Request

Responses

200

application/json

Schema

Schema

page integerrequired

Possible values: >= 1

Default value: 1

Current page

max_page integerrequired

Possible values: >= 1

Default value: 1

Max page based on current per_page value and count

count integerrequired

Default value: 0

Number of items per page.

items

object[]

required

Array [

name stringrequired

formatted_name stringrequired

pm_latency stringrequired

status stringrequired

order numberrequired

Can be used for sorting

published_fields string[]required

required_fields string[]required

included_country_codes string[]required

Array of strings representing the list of country codes

excluded_country_codes string[]required

Array of strings representing the list of country codes

calculated_country_codes string[]required

Array of strings representing the list of country codes

is_indirect booleanrequired

disabled booleanrequired

enabled_by_default booleanrequired

]

Example (from schema)

{
  "page": 1,
  "max_page": 1,
  "count": 0,
  "items": [
    {
      "name": "google_my_business",
      "formatted_name": "Google",
      "pm_latency": "1_day",
      "status": "running",
      "order": 5,
      "published_fields": [
        "string"
      ],
      "required_fields": [
        "string"
      ],
      "included_country_codes": [
        "FR",
        "GB",
        "IT",
        "ES"
      ],
      "excluded_country_codes": [
        "FR",
        "GB",
        "IT",
        "ES"
      ],
      "calculated_country_codes": [
        "FR",
        "GB",
        "IT",
        "ES"
      ],
      "is_indirect": true,
      "disabled": true,
      "enabled_by_default": true
    }
  ]
}

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...