social
insight

List all insights

get/social/{connection_id}/insight

Request

  • Base URL: http://api.unified.to
  • URL: http://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 date-time

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

sort'name' | 'updated_at' | 'created_at'
order'asc' | 'desc'
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

rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.