defaultheader

GET activity {#get}

Get data of one activity object.

Parameters

Parameters | Detail ----------------------- | ------------- format
optional|Specifies returned data format
Accepted value: "json", "xml"

Resource Information

Authentication: See Access Permission for GET activity

HTTP Methods: GET

Request URL Format: https://{api_domain}/api3/activity/{id}

Access Permission {#GetPermission}

Access to data varies base on system setting and requester roles. See Authentication for detail on authentication.

Private WebStorms: Requester must authenticate to get data.

Public WebStorms: No authentication required to get data.

Errors

  • Invalid object ID or you don't have access to this object

Example Request

  • Method: GET
  • Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c

  • URL: https://example.brightidea.com/api3/activity/D2136C62-B65E-40D2-ABD2-873AEF120514

    ~~~ { "activity": { "type": "POSTIDEA", "id": "D2136C62-B65E-40D2-ABD2-873AEF120514", "datecreated": "2013-04-18 12:16:41.720", "ideaid": "0D7C82A2-4B20-42C1-A54C-9608FFF55CDA", "campaignid": "0A140858-AD8A-4F97-9926-D80AD156A130", "campaignname": "Sample Campaign", "ideatitle": "Here is a great Idea Title", "categoryname": "Category 4", "anonymous": false, "teamsubmission": true, "member": { "id": "B471BFED-BCC2-49CC-A917-5F09AA73EEB3", "email": "mpower@example.com", "screenname": "Max Power", "firstname": "Max", "lastname": "Power", "jobtitle": "Safety Inspector", "address": "742 Evergreen Terrace Springfield IL", "phone": "123456-7890", "mobilephone": "987654-3210", "externaluserid": "0072", "skills": "Boxer, Mascot, Astronaut, Baby proofer, Truck driver, Hippie, Plow Driver, Food Critic", "workhistory": "Conceptual Artist, Mayor, Country Western Manager, Garbage Commissioner, Mountain Climber", "photourl": null, "datecreated": "2013-04-18 11:27:48.537", "date_modified": null, "active": true } } } ~~~




# LIST activity {#list} Get data on a list of activity objects. Objects are order by created date descending by default. On retrieving large set of data, requester should use pagination parameters such as `page` and `page_size` to manage multiple requests. ## Parameters Parameters | Detail ----------------------------------- | ----------------------------------- **id**
optional |Filter return by activity ID
**Sample value:** "11111111-1111-1111-1111-111111111111" **date_created**
optional |Filter return by activity created date. Response contains all data created within the 24 hours of the specified date
**Sample value:** "12/06/2009" **type**
optional |Filter return by activity by type.
**Accepted Value:** "POST_IDEA", "POST_BLOG", "PROMOTE_IDEA", "DEMOTE_IDEA", "POST_COMMENT", "POST_BLOG_COMMENT", "REGISTER", "UPDATE_PROFILE", "MY_IDEAS_STATUS_UPDATED", "POST_UPDATE", "POST_ON_WALL" **campaign_id**
optional |Filter return by ID of a campaign
**Sample value:** "11111111-1111-1111-1111-111111111111" **following**
optional |Filter return by members the requester is following. Same result as member landing page.
**Accepted value:** 1 **page_size**
optional |Specifies number of records returns per page. Default: 20. Minimum: 1. Maximum: 100
**Sample value:** 50 **page**
optional |Specifies which page of records to return. Default: 1. Minimum: 1. Maximum: {page_count}
**Sample value:** 5 **order**
optional |A SQL style string that specifies the order the records should return in.
**Sample value:** "date_created ASC".
**Accepted attributes:** "id", "date_created" **format**
optional |Specifies returned data format
**Accepted value:** "json", "xml" ## Resource Information `Authentication`: See [Access Permission](#listPermission) for LIST activity `HTTP Methods`: GET `Request URL Format`: https://{api_domain}/api3/activity ## Access Permission {#listPermission} Access to data varies base on system setting and requester roles. See [Authentication](../authentication) for detail on authentication. **Private WebStorms**: Requester must authenticate to get data. **Public WebStorms**: No authentication required to get data. ## Errors - Invalid object ID or you don't have access to this object ## Example Request - Method: GET - Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c - URL: `https://example.brightidea.com/api3/activity?page_size=2&page=1&type=POST_UPDATE` ~~~ { "activity_list": [ { "type": "POST_UPDATE", "id": "FB4CAD9D-0169-48C8-9553-CD3D30D1B052", "date_created": "2013-04-18 14:51:41.287", "update_id": "9B061C43-4E80-498C-B41E-4482C21632F7", "text": "Test Update to be commented and hifive on", "hifive": [ { "id": "67712BA4-D8FF-48FE-902D-60C734075BE9", "date_created": "2013-04-18 14:53:06.967", "update_id": "9B061C43-4E80-498C-B41E-4482C21632F7", "member": { "id": "B471BFED-BCC2-49CC-A917-5F09AA73EEB3", "email": "mpower@example.com", "screen_name": "Max Power", "first_name": "Max", "last_name": "Power", "job_title": "Safety Inspector", "address": "742 Evergreen Terrace Springfield IL", "phone": "123456-7890", "mobile_phone": "987654-3210", "skills": "Boxer, Mascot, Astronaut, Baby proofer, Truck driver, Hippie, Plow Driver, Food Critic", "work_history": "Conceptual Artist, Mayor, Country Western Manager, Garbage Commissioner, Mountain Climber", "photo_url": null, "date_created": "2013-04-18 11:27:48.537", "date_modified": null } } ], "comments": [ { "id": "9D4C13A3-BBA7-43D9-A450-24C66816511B", "comment": "Here is my comment", "date_created": "2013-04-18 14:51:53.783", "update_id": "9B061C43-4E80-498C-B41E-4482C21632F7", "member": { "id": "866144B1-E302-42EF-AF80-75DE988885AE", "email": "jdoe@example.com", "screen_name": "John Doe", "first_name": "John", "last_name": "Doe", "job_title": "Sales", "address": "123 fake street", "phone": "123 456-789", "mobile_phone": "987 654-3210", "external_user_id": null, "skills": "Selling Software", "work_history": "Worked at sales.com", "photo_url": "", "date_created": "2013-03-07 19:09:54.563", "date_modified": "2013-04-18 13:14:21.067", "active": true, "photo_file_id": "02F11D0E-BA74-4A7D-B1BE-4F7F651B2507" } } ], "member": { "id": "8FA49B96-3693-4282-8919-014618D7B3B8", "screen_name": "Lillian Smith", "first_name": "Lillian", "last_name": "Smith", "job_title": "", "address": "", "phone": "", "mobile_phone": "", "external_user_id": null, "skills": "", "work_history": "", "photo_url": "", "date_created": "2013-03-07 17:10:13.627", "date_modified": "2013-04-16 15:42:16.430" } }, { "type": "POST_UPDATE", "id": "3326811E-5E09-4196-B8AF-FCADE3798173", "date_created": "2013-04-18 11:30:52.930", "update_id": "4317828E-6D09-4234-AA62-50322BBB2EEA", "text": "Test update post 2 - with image", "attachment": { "id": "0BB62224-E6C8-4ED7-8F02-EE1371CCD883", "reference_id": "4317828E-6D09-4234-AA62-50322BBB2EEA", "extension": "jpg", "original_filename": "apple.jpg", "grouping": "Update Photo", "url": "https://example.brightideatest.com/api3/file/0BB62224-E6C8-4ED7-8F02-EE1371CCD883?format=binary", "type": "image/jpeg" }, "member": { "id": "8FA49B96-3693-4282-8919-014618D7B3B8", "screen_name": "Lillian Smith", "first_name": "Lillian", "last_name": "Smith", "job_title": "", "address": "", "phone": "", "mobile_phone": "", "skills": "", "work_history": "", "photo_url": "", "date_created": "2013-03-07 17:10:13.627", "date_modified": "2013-04-16 15:42:16.430" } } ], "stats": { "total": "5", "page_count": 3, "current_page": 1 } } ~~~

FAQ {#faq}

Question: LIST activity only return 100 objects maximum per request. How do I retrieve more results.

Answer: LIST activity response is automatically paginated. You can specify which page of the result a request should return. For example, if you requested for 100 idea objects in the initial request, pass "page_size=100&page=2" to get the next 100. page_count is returned with every LIST request so your application can figure out when it hits the end.

Question: How do I create an update so it will show, or delete an update so it will be removed from the activity feed?

Answer: Use GET update API functions to create or delete updates. You can also comment and hifive on an update as well.