Skip to content
API Reference/
/
Get several Social Posts

Get several Social Posts

Request

Get several Social Posts.

Security
X-API-KEY or Authorization
Query
offsetinteger, (int64)

The offset of the first social post to return

maxinteger, (int64)

The maximum number of social posts to return

locationIdsArray of strings

Return social posts for this locations

socialPostStatusesArray of strings

Return social posts with these statuses

isStoreLocatorboolean

Is the post for store locator

campaignIdsArray of strings

Return social posts for these campaigns

querystring

Free-text search matched against post title and description

curl -i -X GET \
  'https://uberall.com/api/social-posts?offset=0&max=0&locationIds=string&socialPostStatuses=string&isStoreLocator=true&campaignIds=string&query=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Social Posts retrieved.

Bodyapplication/json
statusstringrequired
Enum:"SUCCESS""PENDING""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

Response
GetSocialPostsExample
{
  "status": "SUCCESS",
  "response": {
    "offset": 0,
    "max": 3,
    "count": 1,
    "socialPosts": [ … ],
    "warnings": null,
    "message": null
  }
}