Search posts

GET 
/api/v2/posts

This endpoint lets you browse through all your Posts.

Request

Query Parameters

business__in string[]

Limit results to a specific businesses

start_datetime string

Filters Posts based on their start datetime.

The start datetime represents the moment on which a Post of type event/offer will become available. In case of Posts of type news, the start_datetime it will be compared to the creation date of the Post, as the field is not present in this context.

end_datetime string

Filter Posts based on their end datetime.

The end datetime represents the date on which the Post of type event/offer will expire. In case of Posts of type news, the end_datetime it will be compared to exactly one week after the creation date of the Post, as the field is not present in this context.

summary string

Filter Posts based on their description.

It returns Posts that contain in their description the given string. The text does not have to match perfectly.

topic_type__in string[]

Possible values: [standard, event, offer, alert]

Filter Posts based on a list of different types.

state__in string[]

Possible values: [live, to_configure, pending, scheduled, error, expired]

Filter Posts based on their description.

It returns Posts that contain in their description the given string. The text does not have to match perfectly.

platform__in string[]

Possible values: [google_my_business, facebook, instagram]

Filter Posts based on a list of different platforms.

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 [

id integerrequired

post_type stringrequired

Possible values: [standard, event, offer, alert]

summary stringrequired

Main text content of the post.

business_id string

title stringnullable

The title of the post

start_at stringnullable

For either event or offer post type. Defined when it start. Timezone is defined by the business timezone.

end_at stringnullable

For either event or offer post type. Defined when it end. Timezone is defined by the business timezone.

schedule_time stringnullable

Date when the Post will be published. No scheduled start time means that the Post will be published immediately.

post_medias

object[]

The photo that will be on the Post

Array [

media_url string

URL of the image displayed with the post.

]

created_at date-time

updated_at date-timenullable

business_info string

name and address of the business that the post is related to.

post_insight

object[]

Statistics related to the posts on the different platforms.

⚠️ Due to a Google deprecation, on 20/02/2023, Google views and counts won't be available anymore. Old insights will still be sent. Facebook ones will still be available.

Array [

name string

Possible values: [google_my_business__posts, facebook__posts, instagram__posts]

Publisher related to the post

click_count integer

number of times a user has clicked on the post.

view_count integer

number of times the post has been viewed.

]

post_status

object[]

Status related to the posts on the different platforms.

Array [

name string

Possible values: [google_my_business__posts, facebook__posts, instagram__posts]

Publisher related to the post

state string

Possible values: [live, to_configure, pending, scheduled, error, expired]

The state of the post, indicating at which lifecycle stage it is currently.

link stringnullable

Link displayed in the post to redirect the client clicking on it.

]

offer_terms stringnullable

Terms and conditions of the offer

offer_code stringnullable

Offer code that is usable in store or online

cta_link stringnullable

Link displayed in the post to redirect the client clicking on it.

cta_type string

Possible values: [book, order, shop, learn_more, sign_up, call, no_cta]

The type of the post to be created. Some type mig.

]

Example (from schema)

{
  "page": 1,
  "max_page": 1,
  "count": 0,
  "items": [
    {
      "id": 0,
      "post_type": "standard",
      "summary": "Wonderful post summary!",
      "business_id": "string",
      "title": "string",
      "start_at": "2050-01-01T09:00:00.000Z",
      "end_at": "2050-01-01T09:00:00.000Z",
      "schedule_time": "2020-01-01T10:00:00.000Z",
      "post_medias": [
        {
          "media_url": "string"
        }
      ],
      "created_at": "2024-10-02T11:04:07.507Z",
      "updated_at": "2024-10-02T11:04:07.507Z",
      "business_info": "Rick - HQ - 157 boulevard Macdonald, Paris",
      "post_insight": [
        {
          "name": "facebook__posts",
          "click_count": 1512,
          "view_count": 2012
        }
      ],
      "post_status": [
        {
          "name": "facebook__posts",
          "state": "live",
          "link": "google.com"
        }
      ],
      "offer_terms": "These are the conditions",
      "offer_code": "PROMO25",
      "cta_link": "google.com",
      "cta_type": "book"
    }
  ]
}

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