Skip to main content

Search posts

GET 
/api/v2/posts

Search posts

Request​

Query Parameters

    start_datetime date-time

    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.

    Example: 2020-11-06T23:59:59
    end_datetime date-time

    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.

    Example: 2020-11-06T23:59:59
    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]

    Filter Posts based on a list of different platforms.

    business__in string[]

    Filter by business ids

    Example: [5409c35a97bbc544d8e26737]

Responses​

This endpoint lets you browse through all your Posts.

Schema

    posts

    object[]

    required

    List of posts

  • Array [

    • summary string

    Main text content of the post.

    id number

    The Post id

    business_id string

    Business id

    title string

    The title of the post

    post_type string

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

    The type of the post to be created. Event and Offer are not yet available for Facebook.

    start_at date-time

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

    end_at date-time

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

    schedule_time date-time

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

    post_medias

    object[]

    @description The photo that will be on the Post

  • Array [

    • media_url string

    URL of the image displayed with the post.

  • ]

    • created_at date-time

    Creation date

    updated_at date-time

    Last update date (either on our platform or on Partner platform)

    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]

    Publisher related to the post

    click_count number

    number of times a user has clicked on the post.

    view_count number

    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]

    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 string

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

  • ]

    • offer_terms string

    Terms and conditions of the offer

    offer_code string

    Offer code that is usable in store or online

    cta_link string

    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.

  • ]

    • page number

    Current page number

    max_page number

    Last page number

    count number

    Number of resources complying with filters

Loading...