October 2023

  • 2023-10-23: Changes to access token expiry breaking change
    Access tokens are now set to expire within 3 months. For further information, consult the authentication documentation. Please note, any tokens previously issued with over 6 months of validity have been adjusted to adhere to the new policy, expiring 3 months from 2023-10-23.

February 2023

  • 2023-02-21: Include Review service details in the mention object
    For reviews, a service_details field was added with following (optional) fields:
    Location reviews
    • location_id
    • location_name
    • location_url
    • location_address
    App reviews
    • app_id
    • app_name
    Product reviews
    • product_id
    • product_name
    Shop reviews
    • shop_id
    • shop_name

October 2022

  • 2022-10-25: Including location details when mention object is sent via a webhook.
    • location.continent
    • location.country
    • location.city
    • location.region
    • location.longitude
    • location.latitude
  • 2022-10-27: Changes to JSON encoding breaking change
    We are no longer encoding multibyte Unicode characters literally, (encoding multibyte chars no longer as \uXXXX). This change goes into effect if you are not specifying the version or any version above 20221028.
  • 2022-10-05: The field stripped_content has been added to the Mention object.
    It will return a version of the mentions content field which is stripped from HTML tags.

September 2022

  • 2022-09-30: Changes to updating a mention breaking change
    When updating a mention with the endpoint /{account_id}/inbox/mention/{topic_id}/{id} an error of type invalid_parameter will be returned if you update the status of the mention to the same status. This change goes into effect if you are not specifying the version or any version above 20220930.

May 2022

  • 2022-05-11: New metadata fields for mention_action
    The mentions/cases endpoints and every endpoint that returns a mention/case will now have new properties added to the `metadata` field.
    • previous_priority was added next to priority with the same possible values: 'low', 'medium', 'high', 'critical'
    • display_name was added to mention_assignee

January 2022

  • 2022-01-18: More timestamps added to the Mention object
    The object timestamps on the Mention Object has been updated. This array can contain the following new properties:
    • unresolved_time: The total time a case has been in unresolved status, in seconds.
    • unresolved_time_during_bh: The total time (during business hours) a case has been in unresolved status, in seconds.
    • pending_time: The total time a case has been in pending status, in seconds.
  • 2022-01-03: The mention API will return the buttons & clicked buttons of a mention
    Objects of type mention will now have two optional additional fields: buttons (the list of buttons/quick replies that were send) and clicked_buttons (a list with the buttons the user selected from the sent multiple choice question).

December 2021

  • 2021-12-06: New metadata field for mention_action
    The mentions/cases endpoints and every endpoint that returns a mention/case will now contain a new property called `metadata` which will contain the `note` property of the action in json format like all the rest of the payload. Current types which will return metadata:
    • status with possible values: 'new', 'done'
    • priority with possible values: 'low', 'medium', 'high', 'critical'
    • assignees which returns an array of mention_assignee

July 2021

  • 2021-07-15: Case insensitive natural sorting update
    The API endpoints that return configuration objects (e.g. the endpoint that returns business hours schedules, publishing guidelines, tags, etc.) return their objects sorted using a natural sorting algorithm. We are now changing this algorithm to be case insensitive, rather than case sensitive, since we believe this is a better experience in the tool. This will also impact the API.
  • 2021-07-12: New mention.todos field for mention update
    Objects of type mention will now have the field todos. It contains a list of to-do's that were added in notes attached to a mention.

June 2021

  • 2021-06-30: New endpoint to fetch a single case and it's linked mentions new
    We have added a new /{account_id}/inbox/case/{topic_id}/{id} endpoint that returns a single case together with it's linked mentions, in the same case_conversation format as the /{account_id}/inbox/cases endpoint. You can use this endpoint if you need the details of a single case only, but together with all of its linked mentions.
  • 2021-06-02: Change to behavior of contact update endpoint breaking change
    When updating a contact via the /{account_id}/inbox/contact/{contact_id} endpoint we will now only update the tags of a contact if you specify the property 'tags' in the updates parameter. To clear the contact tags of a contact you should thus now specify the updates param as {"tags":[]} instead of `{}`. We have made this change so you don't accidentally clear contact tags when updating other properties of a contact. If you would like to keep using the previous behavior of this endpoint, please provide a version parameter lower than "20210601".,

May 2021

  • 2021-05-21: New mention.source.thread_id field for mention update
    Objects of type mention will now (optionally) have a field mention.source.thread_id. This field is to indicate to which "thread" a comment/reply belongs. If you have e.g. a Facebook Post A, a comment to it B, and a reply C to that comment. The thread_id of both the comment and reply to that comment will point to post "A". This new field allows you to re-build threads that are more than 1 level deep. This data isn't available for all sources.

February 2021

  • 2021-02-03: Topics endpoint returns details about monitored profiles update
    We have updated the /{account_id}/settings/topics endpoint. The API response will now also include all monitored profiles of each topic.

January 2021

  • 2021-01-19: Various documentation improvements update
    We have updated the parameter documentation for our API Endpoints that support filtering, to include a link to our new API FAQ question that details how filtering works in Engage and in the API.
    We have also added some more examples to our API endpoint to publish & reply to mentions to include how replying with a private message and with e.g. a CSAT question can be done.
  • 2021-01-19: /{account_id}/inbox/contact/{service}/{service_id} endpoint now includes phone number for WhatsApp contacts new
    When using the /{account_id}/inbox/contact/{service}/{service_id} endpoint to request details about a WhatsApp contact, the result will now always include the telephone number of the WhatsApp contact even if the information wasn't previously saved or confirmed by an agent via the tool. Since we have to do an API call to fetch this information ourselves, we're only including this information in the endpoint that returns a single contact, and not endpoints that list several contacts, unless it was previously saved via the interface.

December 2020

  • 2020-12-04: "Reply with PM" now also available on some public mentions update
    Applications that have been allow-listed for "reply with a private message" functionality via the API, can now also reply with a private message on public data if the source supports this functionality. You can reply in the same way, via the endpoint /{account_id}/publisher/add, as you would reply on a private message.
    Whether or not a public mention can be replied to is indicated by the action_link on the mentions. If an action_link with key "privatemessage" is available, it can be replied to with a private message.
    Reach out to your CSM if you want to be allow-listed for this feature; in that request, please include the use case of your application.

October 2020

  • 2020-10-30: New parameters for Tags endpoint new
    The /{account_id}/settings/tags endpoint now has two additional parameters to control which tags are returned. You can choose to only return smart tags, and also whether or not any tags that are related to XM Discover enrichment categorization models should be included.
  • 2020-10-01: message.entities in the mention object will be empty by default info
    This change goes into effect if you are not specifying the version or any version above 20201001. message.entities represents entities extracted from the content and will now only be available upon request.

September 2020

  • 2020-09-23: Contact data added to response of Cases endpoint new
    The /{account_id}/inbox/cases endpoint now also returns a `contact` object for cases that were auto-created for a certain author. The contact object will contain any custom attributes and data saved in the Engage CRM.

July 2020

  • 2020-07-02: Business hours schedule object includes online status information of users new
    Endpoints returning business_hours_schedule objects, will now include an object users that contains the number of users that have the business hours configured, and how much of them are available, busy or unavailable.

June 2020

  • 2020-06-24: Content of Youtube mentions no longer shared breaking change
    Objects of type mention that represent YouTube videos or comments, will no longer contain all properties (like the comment text, or author's name). Instead, only Qualtrics Social Connect specific data will be returned, as well as the identifiers of the video/comment. These identifiers can then be used to retrieve the data from the Youtube Data API. We're making this change to ensure that any usage of YouTube data obtained via our platform is used in accordance to their Terms of Service and other policies.
  • 2020-06-23: New Mention Object field to see if it was handled by a bot or another application new
    For mentions that are handled by a flow or another application, we are now exposing details (including the flow id if relevant) as an object on the mention Object.
  • 2020-06-16: New endpoint to more easily retrieve cases and mentions linked to them new
    For more info read the endpoint document.

May 2020

  • 2020-05-28: New Mention Object fields new
    The field part_of_cases.mention_identifiers was added to the mention object, indicating whether this mention is part of one or more cases.
  • 2020-05-25: page_token cursors changing for /{accountid}/inbox/mentions endpoint
    We are changing how we generate & interpret cursors for the /{accountid}/inbox/mentions API endpoint. From today on the returned page_token will have been made using a different algorithm. When requesting data from the endpoint with a page_token, page_tokens generated before today will continue to work until 2020-06-08. After that date, only page_tokens generated after today will be valid. If your application requests data from this endpoint (and uses the returned page_token) at least once in the coming 2 weeks, there's no action you need to take.

April 2020

  • 2020-04-27: Deprecation of Mention Object fields deprecation
    assigment.team_ids and assigment.user_ids will no longer be able when stating a version bigger or equal to 20200427.
  • 2020-04-27: New Mention Object fields new
    The field assignees was added to the mention object. It contains a set of mention_assignee objects giving more details about the users and teams this mention is assigned to.
  • 2020-04-16: New endpoint for getting the user role for a certain user new
    Read the documentation about this.
  • 2020-04-14: `gender` property removed from `contact` object breaking change
    On each call where one or more `contact` objects are returned, the response will no longer contain a `gender` property. The Gender feature in our CRM has been removed because it was a binary option. We encourage accounts that want to identify genders via the CRM to set-up a custom contact field with non-binary options too. Our API returns all custom contact fields on a contact.

March 2020

  • 2020-03-23: Support for Webhook Signatures new
    We have made it possible to (optionally) sign our Automation Recipe Webhooks. Read the documentation about this.
  • 2020-03-05: New Mention Object fields for Rating Results new
    For mentions that are NPS/CSAT answers, we are now exposing details (including the given rating) as attachment-object on the mention Object. See updated definition of the mention_attachment object.

February 2020

  • 2020-02-10: Topics of a user role added to userrole object. new
    Endpoints returning userrole objects, will now include a property topics that is a list of all topics this user role has access too.
  • 2020-02-10: Rate Limiting mechanism changed change
    For oAuth authenticated API calls, we are preparing changes to allow to create multiple valid `oauth_token`'s (e.g. with different scopes). For this we are also changing the way rate limiting is measured; going forward it will be measured by the User ID associated with the `access_token` used. This means that `access_token`'s associated with the same user will share rate limit allocations. `access_token`'s for different users will of course not impact each other. Our documentation on rate limiting has been updated.
  • 2020-02-05: Now possible to get individual business hours schedule. new
    Accepting GET header in /{account_id}/settings/businesshoursschedule/{id} endpoint. It returns business_hours_schedule object of the specified id. See the Response documentation for more details and example.
  • 2020-02-05: Addition of validation if within Business hours for account. new
    Endpoints returning business_hours_schedule objects, will now include a property is_active that is true if within the business hours otherwise it will be false.
  • 2020-02-05: Addition of validation if within Business hours for user. new
    Endpoints returning user objects, will now include a property businesshours_is_active that is true if within the business hours otherwise it will be false.
  • 2020-02-03: `company` property removed from `user` object breaking change
    On each call where one or more `user` objects are returned, the response will no longer contain a `company` property. The ability for Engage users to fill in their company in their personal settings was since long removed, so it didn't make sense to continue to expose this in the API. (Note: the `company` property on a `contact` object is not affected.)

January 2020

  • 2020-01-31: Expose user's availability status with API new
    On each call where one or more `user` objects are returned, the response will now also contain the user's status (Available, Unavailable, Busy).
  • 2020-01-28: New Mention Object fields new
    We added 2 new fields to the Mention Object. mention.author.managed to indicate if the author of the mention a connected stream in Engage. mention.source.sender to indicate who or what sent the mention.
  • 2020-01-20: Permissions of a user role added to userrole object. new
    Endpoints returning userrole objects, will now include a property permissions that is a list of all permissions this role has. See the Response documentation for a list of all possible permissions.
  • 2020-01-15: New endpoint to initiate handover between Qualtrics Social Connect and your application. new
    We have released the new /{account_id}/inbox/handover/{service}/{service_id} endpoint. This makes it possible to retrieve the current handover state between Qualtrics Social Connect and your application/bot for a specific contact. This also enabled you to make your application the owner of the conversation or pass it back to Engage. You can use this endpoint for Live Chat, WhatsApp, Viber & Twilio. Please reach out to your Customer Success Manager to learn more.

December 2019

  • 2019-12-03: Example Bot Application new
    With the QSC API it's possible to build a cross-platform Bot; build once, and use on any of the Qualtrics Social Connect supported services. To showcase how to build this, we have open sourced an example application. See the Bot Example Application.
  • 2019-12-03: PHP & Javascript SDK's released new
    We have made a PHP & Javascript SDK available for you to include in your projects, to make it easier to work with our QSC API. Get started with the SDK's.

November 2019

  • 2019-11-25: Directly sending private messages via the API new
    You can now use the /{account_id}/publisher/add endpoint to directly send a private message. Previously it was only possible to create drafts or send messages for approval. For private messages we're now allowing them to be published immediately. (For public posts & replies nothing changes.) This functionality is only available to some API applications. Please reach out to your Customer Success Manager to learn more.

October 2019

  • 2019-10-07: New endpoint to send outbound messages to WhatsApp users new
    You can now use the /{account_id}/notifications/add endpoint to send outbound WhatsApp Messages to your audience. (This endpoint is only available for some applications. Please contact your Customer Success Manager to discuss access.)

June 2019

  • 2019-06-17: No longer returning the Tweet URL for Tweets breaking change
    As per Twitter's API ToS, we have stopped returning source.url for Tweets when returning mention response objects. Use this endpoint to look up multiple tweets at once. Read more

December 2018

  • 2018-12-07: Now possible to remove a user from an account new
    You can now also use the /{account_id}/settings/user/{id} endpoint to remove a user from an account.
    Available for some apps only.
  • 2018-12-07: Now possible to update a user's role new
    You can now also use the /{account_id}/settings/user/{id} endpoint to update the role of a user in the account. (Previously you could only update the business hours schedule of the User.)
    Available for some apps only.
  • 2018-12-07: New endpoint to read the list of user roles of an account new
    You can use the /{account_id}/settings/userroles endpoint to get a list of all user roles (including custom user roles) in an account.
  • 2018-12-07: New endpoint to read a single user's details new
    You can use the /{account_id}/settings/user/{id} endpoint to read the details of a single user in an account. (An update endpoint was already available.)

November 2018

  • 2018-11-03: Maximum amount of pages for /{account_id}/inbox/mentions endpoint breaking change
    For performance reasons we now only allow to page back for 10000 mention objects via the /{account_id}/inbox/mentions endpoint. If you narrow your date range, or make your filter more specific you'll be able to fetch all mentions. The API's response of the last available page will not contain a paging.next_url.

October 2018

September 2018

August 2018

  • 2018-08-29: New endpoint to receive all topics for a certain account new
    You can use the /{account_id}/settings/topics endpoint to get a list of topic objects for your account.

May 2018

  • 2018-05-18: Access token revoked on password changed
    For security reasons, from now on, we will revoke all access_token's from the applications a user authorized, when a user changes their password. This will result in a standard OAuth error. You will be able to resolve by just re-authenticating the user. Read more about authenticating with our API.

April 2018

  • 2018-04-06: Property added for mention response object new version 20180406
    The new property unique_id is now filled in as a Qualtrics Social Connect specific identifier for the mention.

February 2018

January 2018

December 2017

  • 2017-12-22: Property added for publisher_mention response object new
    We've added the property in_reply_to of the type mention. This is an optional property that will only be returned on the endpoint /{account_id}/publisher/mention/{id} and only if the post is a reply to a mention.
  • 2017-12-18: TLS 1.0 Deprecated breaking change
    As announced on our Changelog, we have deprecated TLS 1.0 for all our services. Our apologies for not communicating about this via this Developer Changelog. Here's why we made this change:

    Data security and integrity are top priorities for Qualtrics. As part of our ongoing commitment to ensuring all Qualtrics products are secure, we have taken a similar decision to many other SaaS companies in disabling the use of TLS 1.0.

    Qualtrics plans to disable TLS 1.0 encryption as an industry best practice. If you are using a browser that does not support modern encryption protocols, or if you are using a browser other than the supported browsers, you will experience issues accessing Qualtrics Social Connect and other Qualtrics Hosted Services.

    This is remedied upgrading your browser or http clients to a modern version.

November 2017

  • 2017-11-27: Extra Canned Responses Variables new
    If you want to format canned responses with [profile.name] or [profile.url] you need to pass reply_type, service_type and service_id to /{account_id}/settings/canned_responses. We've also added a new order parameter to sort the canned responses.
  • 2017-11-22: Property added for user response object new
    The property avatar is added to the user response object.
  • 2017-11-22: Priority of case becomes an object with more information version 20171122 breaking change
    Only passing the priority of a case was not enough. From now on you will also receive the name and color of the priority.
  • 2017-11-01: Properties type change for contact response object bug fix
    The properties contact.date.added and contact.date.updated would sometimes be returned as a string representation of the date instead of a UNIX timestamp that was described in the documentation.

October 2017

  • 2017-10-31: New endpoint for getting the context of a mention new
    You can use the /{account_id}/inbox/context endpoint to get more context about a mention (the previous conversations with the customer, notes added by users, etc.).
  • 2017-10-25: Added contact.permalink property to contact response object new
    We have added the property contact.permalink to the contact object. This object contains a link straight to the contact's details in the Qualtrics Social Connect tool, and can be used to link to in your apps.
    Meanwhile we have taken the opportunity to improve documentation on all of the contact object's properties.
  • 2017-10-25: Removed obsolete contact object fields change
    We have removed the properties contact.url, contact.address.street, contact.address.number, contact.address.zip from the contact object since they are unavailable to fill in in the interface and are thus obsolete.
  • 2017-10-25: Users with a "Free Analytics User Role" no longer have API Access breaking change
    Some account plans have the ability to create unlimited "free analytics" users. These are users with limited view rights in the application. We are disabling API access for these users since that is not intended use for this use case, and since by creating extra of these users the Rate Limiting restrictions could be circumvented, which can have negative impact on the site's performance.
  • 2017-10-06: We've added an extra field on the mention object new
    We have added the property extra_fields to every returned mention object.
  • 2017-10-02: Changes to updating a contact's country new
    When updating a contact via the /{account_id}/inbox/contact/{service}/{service_id} endpoint, you can now supply both address.country.name and/or address.country.code as updates. When `code` is set, that one will get precedence, or when `name` is set for the country, we'll look up the provided name in our English list of countries to find the corresponding code. If you provide a country name we don't recognize, an error of type invalid_parameter will be returned. We use ISO 3166-1 alpha-2 for country codes.
  • 2017-10-02: Overwrite all custom attributes new
    You can now overwrite all existing custom attributes of a contact by new provided values using the new customattributes_edit_mode:overwrite option parameter for the /{account_id}/inbox/contact/{service}/{service_id} endpoint. This edit mode will remove all existing attributes, and set the new provided ones. (Similar to the tags_edit_mode option.)

September 2017

  • 2017-09-27: Fetch only contacts with certain tag new
    You can now restrict contacts returned by the /{account_id}/inbox/contacts endpoint so only contacts with a certain tag are returned by supplying a filter argument, and filter on a contact tag, with e.g. contacttag:yourtagname.
  • 2017-09-25: Fetch only updated contacts new
    You can now restrict contacts returned by the /{account_id}/inbox/contacts endpoint so only contacts updated after a certain date are returned.
  • 2017-09-25: We've added sorting options for contacts endpoint new
    You can now choose how you want the list of contacts returned by the /{account_id}/inbox/contacts endpoint to be sorted, by creation date or by last update.
    We have also added the properties date.added and date.updated to every returned contact object.
  • 2017-09-21: Use canned responses when publishing mention. new
    Selecting a canned response for a mention is now possible using the /{account_id}/publisher/add endpoint.
  • 2017-09-21: New endpoint for getting the folders of the canned responses of an account. new
    Getting the folders of the canned responses of an account is now possible using the /{account_id}/settings/canned_responses_folders endpoint.
  • 2017-09-18: New endpoint for getting the canned responses of an account. new
    Getting the canned responses of an account is now possible using the /{account_id}/settings/responses endpoint.
  • 2017-09-07: New endpoint for marking a todo-item as done or to do during a playbook run new
    Marking a todo-item done or undone during a playbook run is now possible using the /{account_id}/crisis/todo endpoint.
  • 2017-09-07: New endpoint for enabling or disabling a Playbook new
    Enabling or disabling of a Playbook is now possible using the /{account_id}/crisis/event endpoint.
  • 2017-09-07: Playbook Object new fields new
    We've added the summary of a Playbook Object.

June 2017

  • 2017-06-20: Tag Object new fields new
    The Tag Object visible field and category_model_tag field, have been added.

March 2017

  • 2017-03-17: Fetch contact data by contact id new
    You can now also fetch contacts via their contact.id, not only via a combination of the social service and service id. The new endpoint /{account_id}/inbox/contact/{contact_id} works in exactly the same was as the existing /{account_id}/inbox/contact/{service}/{service_id} endpoint.
  • 2017-03-17: Changes to updating a contact breaking change
    The endpoint to update a contact /{account_id}/inbox/contact/{service}/{service_id} has been updated to support updating the contact tags and updating multiple custom attributes at once. For this we had to make a few breaking changes in how you update address data, and custom attributes. We've updated the examples.
  • 2017-03-17: New endpoint for getting a list of contacts new
    Getting the full list of contacts of an account is now possible using the /{account_id}/inbox/contacts endpoint.
  • 2017-03-17: New endpoint for getting the custom attributes of an account. new
    Getting the list of custom attributes of an account is now possible using the /{account_id}/settings/customattributes endpoint.

January 2017

  • 2017-01-26: New endpoint for getting the Playbooks of an account. new
    Getting the Playbooks of an account is now possible using the /{account_id}/crisis/plans endpoint.

June 2016

May 2016

  • 2016-05-26: Date filtering for /{account_id}/publisher/mentions bug fix
    The date filter parameters date_from and date_to of the /{account_id}/publisher/mentions only had effect when you filtered on mentions with status "posted" (i.e. your publisher history). We have fixed that the parameters now always have effect.

April 2016

March 2016

February 2016

January 2016

  • 2016-01-19: New Actionlink Object field new
    The Actionlink Object field post_params has been added. This optional field will be filled when a POST action link requires specific arguments.
  • 2016-01-08: Email user on assignment version 20160108 new
    We've added the option to send out an email when a mention is assigned using the /{account_id}/inbox/mention/{topic_id}/{id} endpoint to update a mention.
  • 2016-01-05: New Mention Object field new
    We've added the user tags for the author of a Mention Object.

December 2015

  • 2015-12-31: New endpoint to delete a mention new
    We have added support for deleting a Mention Object. Make a DELETE http request to /{account_id}/inbox/mention/{topic_id}/{id} to remove the mention from Qualtrics Social Connect. Optionally you can also request to have the mention deleted from Facebook/Twitter, etc.
    When requesting mentions you will now also get back an Actionlink Object with key: delete.
  • 2015-12-31: New Actionlink Object field new
    The Actionlink Object field http_method has been added. This field describes which http method you should use when making the request to the link. This has been added to distinguish between GET, POST and DELETE requests.
  • 2015-12-31: Support for changing sentiment of Mention Object new
    It's now possible to update the sentiment of a single Mention Object. Make a POST request to /{account_id}/inbox/mention/{topic_id}/{id} with e.g. updates={"message":{"sentiment":"positive"}}. More details in this example.
  • 2015-12-28: Removed notes from Contact Object breaking change
    The field notes of the Contact Object has been removed, in favour of using notes on Mention Objects
    If you want to add unstructured information to a contact you can use the comments field of the Contact Object.
  • 2015-12-24: New Mention Object fields documentation new
    The Mention Object field entities, has been documented. This array can contain the following objects;
  • 2015-12-24: Adding notes to Publisher Mention Object new
    You can now add notes to the Publisher Mention Object via the API. Make a POST request to /{account_id}/publisher/mention/{id} with updates={"actions":[{"type":"note","extra":"Text of the note to be added goes here."}]}. More details in this example.
  • 2015-12-24: New Publisher Mention Object fields new
    The object actions has been added to the Publisher Mention Object. This array contains Mention Action Objects similar to Action objects of Mention Objects.
  • 2015-12-22: New API endpoint for viewing the Security Audit Log new
    Via the new /{account_id}/security/audit endpoint you can fetch all security audit logs for a certain account. Full documentation can be found on the Endpoint documentation page.
  • 2015-12-11: New Mention Object fields new
    The object timestamps has been added to the Mention Object. This array can contain the following properties:
    • response_time: The time between date.published and the first reply (if any), in seconds.
    • response_time_during_bh: The time (during business hours) between date.published and the first reply (if any), in seconds.
    • resolve_time: The time between date.published and the first resolve date (if any), in seconds.
    • resolve_time_during_bh: The time (during business hours) between date.published and the first resolve date (if any), in seconds.
    • handle_time: The total time spent handling this message, in seconds.

September 2015

January 2015

  • 2015-01-20: New API Endpoint for fetching mailboxes configuration new
    Via the new /{account_id}/inbox/mailboxes endpoint you can get the configuration details of all mailboxes configured for an account. The configuration of eg. a certain mailbox folder can then be used to decide on which parameters to send to the /{account_id}/inbox/mentions API endpoint to fetch mentions for a certain smart folder.
  • 2015-01-16: We have created a FAQ page new
    Several of the questions people ask when starting out with our API are answered here.
  • 2015-01-06: New API Endpoint for fetching account history new
    Via the new /{account_id}/settings/history endpoint you can fetch the audit log of all configuration changes to an account. You can filter on type, topic and/or user.

November 2014

  • 2014-11-21: Dashboard endpoint now also returns layout details new
    The dashboard_widget response object now also includes details about the width, height and positioning of each widget on the dashboard. So if you're using the /{account_id}/dashboards/export/{dashboard_id} endpoint you will now also receive these extra details.
    We also made sure the widgets in the resultset are sorted in a more logical way.

October 2014

  • 2014-10-29: Sorting inbox mentions new
    Our /{account_id}/inbox/mentions endpoint now has an extra (optional) sort parameter to retrieve mentions in the order you like; from new to old, from old to new, by latest edit date, etc.

September 2014

  • 2014-09-08: Better sentiment detection API new
    Our /tools/sentiment endpoint has been updated to use our improvement sentiment detection algorithm, and also accepts an optional language parameter if you want to bypass our automatic language detection.

July 2014

  • 2014-07-23: New Mention Object field new
    The field source.service, showing if a mention is from "twitter", "facebook", or other known service has been added to the Mention Object. This is now recommended over the source.type field which contains more internal names for our services (eg. SearchProviderTwitter for Twitter).

June 2014

  • 2014-06-03: Creating drafts and sending messages for approval new
    It is now possible add messages to Qualtrics Social Connect to be published on your social profiles. Full documentation and a few examples can be found on the Endpoint documentation page.
    Note: We cannot expose real publishing functionality in our API per third-party terms of service agreements (eg. Twitter API Rules), so only creating drafts, or queueing messages for approval is exposed to non-Qualtrics Social Connect applications.
    (This is a first version of this API-call; you cannot yet attach images to the posts. We would love to hear your feedback.)

February 2014

  • 2014-02-04: Updating mentions new
    It is now possible to add notes to mentions via the API, or to add/delete one or more tags from a mention without affecting the current ones. See the examples on the Endpoint documentation page.
  • 2014-02-04: Several new endpoints new
    We have added several new endpoints:
    1. Lists all of the tags of a certain account, details.
    2. List details of a certain social profile, details.
    3. Return a list of mentions (or a single mention) waiting for approval, messages in draft, details here and here.

January 2014

  • 2014-01-15: Mention changes breaking change
    The field assignment of the Mention Object has been split into assignment.user_ids and assignment.comment.

November 2013

  • 2013-11-29: Field Expansion support new
    API endpoints returning data (GET) now all support a "fields" parameter (click "Advanced" in the API Test Console to try it out), that controls which data will be returned. This way you can select only the fields you're interested in. This optimization allows you to save on bandwith and can speed up response times of our API. Field expansion works in the same way as described here (under the header "Making Multiple Requests in a Single Call").
    Try it with sending ?fields=name,plan,projects.limit(1).fields(name,topics) to the /me/accounts endpoint.
    More documentation will follow.
  • 2013-11-29: Using ETags new
    For speeding up requests to our API you can now use ETags to know if something has changed since you last request. This works in the same way as eg. the Facebook Graph API, documented here.
    When doing requests to the Qualtrics Social Connect API with the If-None-Match request header, the Response Envelope will also contain a field meta.etag with the etag for that response.
    More documentation will follow.
  • 2013-11-29: OAuth 2.0 grant_type=password new
    We now support the OAuth 2.0 grant type "password" for selected.
  • 2013-11-27: Envelope changes breaking change
    The fields meta.error, meta.error_description and meta.error_details of the Response Envelope have been removed. Non-fatal errors (and warnings) will now be of type message in the meta.messages field.

June 2013

  • 2013-06-03: New Dashboard Endpoints new
    We've added 2 new endpoints with which you can query details about the custom dashboards of a certain account. See /documentation/endpoints.

May 2013

  • 2013-05-29: XML Support new
    Include a parameter ?format=xml if you want the response to be in the XML format, instead of the default JSON. Click "Advanced" in the API Test Console to try it out.