Subscriptions define how data is provided to a Squirro project. Subscriptions are attached to Objects.
Methods
List Subscriptions
GET https://topic-api.squirro.com/v0/(string: tenant)/projects/(id: project_id)/objects/{id: object_id}/
subscriptions
Returns an array of all subscriptions on an object.
Parameters: |
|
---|---|
Query Parameters: |
|
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes. |
Returns: |
Array of subscriptions. [ { "title": "Squirro", "deleted": false, "modified_at": "2014-06-24T14:44:05", "seeder": null, "provider": "twitter", "source_id": "MrGpdl_3TLmPLm5sj36XPw", "link": "https://twitter.com/squirro", "config": { "username": "squirro" }, "id": "v-Jn3eOVQB2fyWRLkQKNvg" } ] |
Create Subscription
POST https://topic-api.squirro.com/v0/(string: tenant)/projects/(id: project_id)/objects/{id: object_id}/
subscriptions
Adds a new subscription to the object.
Parameters: |
|
---|---|
Form Parameters: |
|
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes. |
Returns: |
The created subscription. { "title": "@squirro", "deleted": false, "modified_at": "2014-12-17T17:13:26", "seeder": null, "provider": "twitter", "source_id": "Ktj-t6ArTRKBmxLqcDXixw", "link": "https://twitter.com/squirro", "config": { "username": "squirro" }, "id": "4y6tFv8ZRaOa4FlwxSPzOA" } |
Get Subscription
GET https://topic-api.squirro.com/v0/(string: tenant)/projects/(id: project_id)/objects/{id: object_id}/subscriptions/{id: subscription_id}
Return details about an individual subscription.
Parameters: |
|
---|---|
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes. |
Returns: |
The subscription. { "title": "@squirro", "deleted": false, "modified_at": "2014-12-17T17:13:26", "seeder": null, "provider": "twitter", "source_id": "Ktj-t6ArTRKBmxLqcDXixw", "link": "https://twitter.com/squirro", "config": { "username": "squirro" }, "id": "4y6tFv8ZRaOa4FlwxSPzOA" } |
Update Subscription
PUT https://topic-api.squirro.com/v0/(string: tenant)/projects/(id: project_id)/objects/{id: object_id}/subscriptions/{id: subscription_id}
Updates a subscription. The provider of the subscription can not be modified after creation, just the configuration is editable.
Parameters: |
|
---|---|
Form Parameters: |
|
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes. |
Returns: |
The modified subscription. { "title": "@mymemonic", "deleted": false, "modified_at": "2014-12-17T17:19:05", "seeder": null, "provider": "twitter", "source_id": "OEt5xjs4TlmnyNMiMpnSXQ", "link": "https://twitter.com/mymemonic", "config": { "username": "mymemonic" }, "id": "4y6tFv8ZRaOa4FlwxSPzOA" } |
Delete Subscription
DELETE https://topic-api.squirro.com/v0/(string: tenant)/projects/(id: project_id)/objects/{id: object_id}/subscriptions/{id: subscription_id}
Delete a subscription.
Parameters: |
|
---|---|
Form Parameters: |
|
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes. |