api---alerts

Get alerts by feed (v1)

Returns paginated list of alerts (by feed ID) for currently authenticated user.

get/api/v1/listing-alerts/feeds/{id}

Request

  • Base URL: https://api.casafari.com
  • URL: https://api.casafari.com/api/v1/listing-alerts/feeds/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

A unique integer value identifying this alerts feed.

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

Offset from which to start the search. Maximum value is 50000.

order_by'alert_date' | '-alert_date' | 'alert_id' | '-alert_id' | 'created_at' | '-created_at' | 'updated_at' | '-updated_at'

The field by which to sort the results.

alert_date_fromstring date

Start date (in the format YYYY-MM-DD) of the period for alerts of interest.<br/>Overrides alert_date_from value if it was specified in the feed filter.<br/>Invalid values are ignored.

alert_date_tostring date

End date (in the format YYYY-MM-DD) of the period for alerts of interest.<br/>Overrides alert_date_to value if it was specified in the feed filter.<br/>Invalid values are ignored.

created_at_fromstring date-time

Start date and time (in the format YYYY-MM-DDTHH:mm:ss) to filter alerts by their creation in the database (UTC). Useful for incremental sync to avoid fetching already fetched data.<br/>Overrides created_at_from value if it was specified in the feed filter.<br/>Invalid values are ignored.

created_at_tostring date-time

End date and time (in the format YYYY-MM-DDTHH:mm:ss) to filter alerts by their creation in the database (UTC). Useful for incremental sync to avoid fetching already fetched data.<br/>Overrides created_at_to value if it was specified in the feed filter.<br/>Invalid values are ignored.

created_at_with_photos_fromstring date-time

Start date and time (in the format YYYY-MM-DDTHH:mm:ss) to filter alerts by their creation in the database (UTC), only including alerts for which photo processing has been completed. Use it to fetch alerts with already assigned photos. Note: Some alerts may still not have photos if the original listing did not include any.<br/>Overrides created_at_with_photos_from value if it was specified in the feed filter.<br/>Invalid values are ignored.

created_at_with_photos_tostring date-time

End date and time (in the format YYYY-MM-DDTHH:mm:ss) to filter alerts by their creation in the database (UTC), only including alerts for which photo processing has been completed. Use it to fetch alerts with already assigned photos. Note: Some alerts may still not have photos if the original listing did not include any.<br/>Overrides created_at_with_photos_to value if it was specified in the feed filter.<br/>Invalid values are ignored.

alert_subtype'new' | 'price_up' | 'price_down' | 'reserved' | 'delisted' | 'sold'

Get only alerts of the specific subtype (for the requested feed).<br/>Invalid values are ignored.<br/><strong>This field is deprecated and will be removed in the next major update.</strong><br/><strong>Please, use alert_subtypes field in the feed.filter instead.</strong>

Response

countinteger
nextstring uri nullable
previousstring uri nullable

Example response

[
  {
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100"
  }
]

Changes

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