social
insight

List all insights

Changed on

Returns a list of SocialInsights. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

get/social/{connection_id}/insight

Request

  • Base URL
    https://api.unified.to
  • URL
    https://api.unified.to/social/{connection_id}/insight
  • Auth
    API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

profile_idstring

The profile ID to filter by

post_idstring

The post ID to filter by

start_gtestring

The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_ltstring

The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for the insight data point

created_atstring date-time

When the insight was recorded (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

profile_idstring

The social profile these stats belong to

post_idstring

Optional: the post these stats belong to

datestring date-time

The day/timestamp of the data point

period'DAY' | 'WEEK' | 'MONTH' | 'LIFETIME' | 'TOTAL' | 'OTHER'

The aggregation period of the value

metric'FOLLOWERS' | 'FOLLOWING' | 'POSTS' | 'IMPRESSIONS' | 'REACH' | 'ENGAGEMENT' | 'PROFILE_VIEWS' | 'CLICKS' | 'VIDEO_VIEWS' | 'LIKES' | 'COMMENTS' | 'SHARES' | 'SAVES' | 'OTHER'

The metric being reported

valuenumber

The metric value

rawobject

Raw data from integration

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status