Privileged API Keys Only
Special permission is required to access this service. Please contact api-support@sparkplatform.com or your API key provider to request access to this data.

News Feed

A news feed is a subscription to a data point or actions of interest, such as the results of a saved search. These subscriptions generate news feed events.

News Feed Restrictions
When subscribing to a Saved Search, news feeds are restricted to searches that meet some baseline criteria. Review the News Feed Saved Search Criteria restrictions for details.
  1. Supported Roles
  2. Available Services
    1. All News Feed Subscriptions
    2. All News Feed Subscriptions for Contacts
    3. Individual News Feed Subscription
    4. News Feed Subscription Validation
  3. News Feed Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads Writes Notes
IDX No No
Public Yes No Only individual news feed subscriptions are accessible.
VOW (As Portal Group) Yes Yes
Portal (As Portal Group) Yes Yes
Private Yes Yes
More information about roles may be found here.

Available Services

All News Feed Subscriptions

/<API Version>/newsfeeds
/<API Version>/contacts/<Contact.Id>/newsfeeds

HTTP Method Description Conditional Notes
GET Returns all news feed subscription information No
POST Creates a news feed subscription to a subscribable data point, such as a saved search. If the user does not have a default schedule, and NotificationsActive is not false, a schedule with a Frequency of Instant will automatically be created for the feed.
If an agent subscribes a contact to a search, the search will also be provided to the contact..		 No
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:

GET Response

{
    "D": {
        "Success": true,
        "Results": [
          {
            "Id": "20130625195235039712000000",
            "ResourceUri": "/vX/newsfeeds/20130625195235039712000000",
            "Active": true,
            "NotificationsActive": true,
            "Curated": false,
            "Name": "My Newsfeed Subscription",
            "Type": "SavedSearch",
            "Events": ["New", "PriceChange", "StatusChange", "BackOnMarket"],
            "UseDefaultEvents": false,
            "CreatedTimestamp": "2013-06-27T10:01:06-05:00",
            "ModificationTimestamp": "2013-06-27T10:01:06-05:00",
            "Subscription": {
              "ResourceUri": "/vX/savedsearches/20100815220615294367000000",
              "Id":  "20100815220615294367000000",
              "OwnerId": "20090815223215294334000000",
              "Name": "Search name here",
              "Description": "A longer description of the search",
              "Filter": null,
              "ModificationTimestamp": "2011-03-14T08:39:38-05:00"
            }
          }
        ]
    }
}

POST Request

Request body: 
{
    "D": {
      "Name": "My Very Special Newsfeed",
      "Subscription": {
        "Id":  "20100815220615294367000000"
        }
    }
}

POST Response

The standard success/fail response is returned.

All News Feed Subscriptions for Contacts

/<API Version>/contacts/newsfeeds

HTTP Method Description Conditional Notes
GET Returns news feeds for all the current user's contacts No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:

GET Response

See the GET request section for for the news feed service.

News Feed Expiration
After creating a News Feed, the feed may become disabled if inactive for a long period of time. Refer to the News Feed Expiration guidelines for details.

Individual News Feed Subscription

/<API Version>/newsfeeds/<NewsFeed.Id>
/<API Version>/contacts/<Contact.Id>/newsfeeds/<NewsFeed.Id>

HTTP Method Description Conditional Notes
GET Returns information for a specific news feed No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Updates the newsfeed No
DELETE Deletes a news feed, and all of its events No The feed is queued for deletion, and is immediately set to Active: false.

GET Request

Parameters:
Parameter Required Notes
Standard expansion parameters No

GET Response

See the GET request section for for the news feed service.

PUT Request

Request body: 
{
    "D": {
        "Name": "My Favorite Newsfeed"
    }
}

PUT Response

The standard success/fail response is returned.

DELETE Request

Parameters:
  • None

DELETE Response

The standard 'accepted for processing' response is returned.

News Feed Subscription Validation

/<API Version>/newsfeeds/validation
/<API Version>/contacts/<Contact.Id>/newsfeeds/validation

HTTP Method Description Conditional Notes
GET Validates a potential saved search _filter for news feed compatibility. No
POST Validates news feed data to be created, but does not perform the actual creation. No
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:
Parameter Required Notes
Standard search syntax (_filter only) Yes

GET Response

{
    "D": {
        "Success": true
    }
}

POST Request

Request body: 
{
    "D": {
      "Name": "My Very Special Newsfeed",
      "Subscription": {
        "Id":  "20100815220615294367000000"
       }
    }
}

POST Response

The standard success/fail response is returned.

News Feed Description

Attribute Data Type Writeable Required Searchable Description
Id Character No No No The unique id for the news feed.
ResourceUri Character No No No The URI to the individual news feed resource.
Active Boolean Yes No Yes If false, the news feed has expired or been disabled and no events will be tracked. Defaults to true.
Curated Boolean Private Role No No If true, events in this news feed are first approved by the agent before they are viewable by a VOW/Portal user. Defaults to false. Read more about curated news feeds here.
Name Character Yes No Yes The custom name for the news feed subscription. Defaults to name of the resource being subscribed to, when applicable.
Events Character List Yes No No The event types the news feed will track changes for. Defaults to null, which tracks all events.
SubscriberId Character No No Yes The Id of the subscriber of this news feed.
SubscriberType Character No No Yes The type of user that is subscribed to this contact. Either Contact, or one of the supported account user types.
UseDefaultEvents Boolean Yes No No When true, the Events array will be null and ignored for this news feed. Instead, the events set in the news feed settings service will be used.
Type Character No No Yes The type of data the news feed subscription is for.
NotificationsActive Boolean Yes No No If false, no scheduled notifications will be sent when an event is added to the news feed. Defaults to true. If false, items will still be added to the news feed if Active is true.
Note: when a news feed is created for users without a default schedule, the news feed will be automatically set up with Instant email notifications.
CreatedTimestamp Timestamp No No No The time the news feed was created.
ModificationTimestamp Timestamp No No Yes The time the news feed was last updated.
Subscription JSON Object Id on creation only. Yes Yes The resource the news feed subscription is for (for example, a Saved Search record).

Searchable by "Subscription"."Id".

Below are the existing news feed Types.

Type Creatable Modifiable Description
FavoritesCart No Yes, except Active and Curated flags. Tracks when listings in the Favorites Portal cart for VOW/Portal users have changed.
RecommendedCart No Yes, except Active and Curated flags. Tracks when listings are added to the Recommended Portal cart for VOW/Portal users.
SavedSearch Yes Yes Tracks specific listing change events for listings that match the corresponding search.

Expansions

Expansion Roles Single Record Only? Selection Support? Description
Schedule All No No The corresponding Schedule records for the newsfeed.
Subscriber Private No No The contact or account record for the subscriber of the news feed.
UnreadEventCount All No No A count of all unread and approved events for the news feed.

API Explorer

Interact with this service using the API Explorer.