Developers

Challenge Lists

There are many ways challenge can be exciting to users. Recently added challenges help people stay on top of exciting things happening within your Brainstorm. Highly rated ones may attract the attention of those who want to contribute their skills. Here are some ways you can get a list of challenges from the Brainstorm API.

Note, the responses from these API requests do not contain the detailed breakdown of the challenge, just some snippets of information. To retrieve a full challenge's profile, including comments, parts, tabs, links, and documents, see Challenge Profile.

User Challenges

Retrieve a list of challenges that a user is a submitter or team member of.

GET: /api/challenge/user?email=[email of user]

Active Challenges

This API endpoint returns the most active recent challenges in Brainstorm as determined by our activity algorithm.

GET: /api/challenge/recentActive

Recent Challenges

This API endpoint returns recently added challenges to Brainstorm, as ordered by the date at which they were submitted.

GET: /api/challenge/recent

Sample Response of Challenge Lists

This particular response is the /api/challenge/recent API call, which orders the response based on when the challenge was submitted, in descending order.

This API endpoint is capable of pagination. Note the presence of the following elements:

<NumberOfResults>2</NumberOfResults>
<Page>0</Page>
<TotalResults>59</TotalResults>
    

For more information on paged results, see the Query Strings that manipulate responses section on the API overview page.

<Results xmlns="http://brainstorm.intuit.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <Data>
        <Challenge>
            <Id>312</Id>
            <IdeaCount>1</IdeaCount>
            <Name>API test challenge</Name>
            <ScoreAllTime>5.1999999999999993</ScoreAllTime>
            <ScoreRecent>4.67</ScoreRecent>
            <StartDate>2011-10-07T16:42:02</StartDate>
            <SubmissionDeadline i:nil="true"/>
            <SubmittedOn>2011-10-07T16:42:12</SubmittedOn>
            <Submitter>
                <Id>18003</Id>
                <DisplayName>Dan Jackson</DisplayName>
                <EmailWork>dan_jackson@intuit.com</EmailWork>
                <Location>0102184, Mountain View, CA</Location>
                <Phone/>
                <PhotoExists>false</PhotoExists>
                <PhotoUrl_36x36>http://localhost.localhost/Images/photo_none_small.jpg</PhotoUrl_36x36>
                <Title>SW Engineer 2</Title>
            </Submitter>
            <WinningIdeaCount>1</WinningIdeaCount>
        </Challenge>
        <Challenge>
            <Id>311</Id>
            <IdeaCount>1</IdeaCount>
            <Name>API test challenge</Name>
            <ScoreAllTime>5.1</ScoreAllTime>
            <ScoreRecent>4.57</ScoreRecent>
            <StartDate>2011-10-07T16:38:22</StartDate>
            <SubmissionDeadline i:nil="true"/>
            <SubmittedOn>2011-10-07T16:38:42</SubmittedOn>
            <Submitter>
                <Id>18003</Id>
                <DisplayName>Dan Jackson</DisplayName>
                <EmailWork>dan_jackson@intuit.com</EmailWork>
                <Location>0102184, Mountain View, CA</Location>
                <Phone/>
                <PhotoExists>false</PhotoExists>
                <PhotoUrl_36x36>http://localhost.localhost/Images/photo_none_small.jpg</PhotoUrl_36x36>
                <Title>SW Engineer 2</Title>
            </Submitter>
            <WinningIdeaCount>0</WinningIdeaCount>
        </Challenge>
    </Data>
    <NumberOfResults>2</NumberOfResults>
    <Page>0</Page>
    <TotalResults>307</TotalResults>
</Results>
            
{
    "Data": [
        {
            "Id": 312,
            "IdeaCount": 1,
            "Name": "API test challenge",
            "ScoreAllTime": 5.199999999999999,
            "ScoreRecent": 4.67,
            "StartDate": "/Date(1318030922000-0700)/",
            "SubmissionDeadline": null,
            "SubmittedOn": "/Date(1318030932000-0700)/",
            "Submitter": {
                "Id": 18003,
                "DisplayName": "Dan Jackson",
                "EmailWork": "dan_jackson@intuit.com",
                "Location": "0102184, Mountain View, CA",
                "Phone": "",
                "PhotoExists": false,
                "PhotoUrl_36x36": "http://localhost.localhost/Images/photo_none_small.jpg",
                "Title": "SW Engineer 2"
            },
            "WinningIdeaCount": 1
        },
        {
            "Id": 311,
            "IdeaCount": 1,
            "Name": "API test challenge",
            "ScoreAllTime": 5.1,
            "ScoreRecent": 4.57,
            "StartDate": "/Date(1318030702000-0700)/",
            "SubmissionDeadline": null,
            "SubmittedOn": "/Date(1318030722000-0700)/",
            "Submitter": {
                "Id": 18003,
                "DisplayName": "Dan Jackson",
                "EmailWork": "dan_jackson@intuit.com",
                "Location": "0102184, Mountain View, CA",
                "Phone": "",
                "PhotoExists": false,
                "PhotoUrl_36x36": "http://localhost.localhost/Images/photo_none_small.jpg",
                "Title": "SW Engineer 2"
            },
            "WinningIdeaCount": 0
        }
    ],
    "NumberOfResults": 2,
    "Page": 0,
    "TotalResults": 307
}
            

Explaination of pagination elements

  • The <NumberOfResults> value designates how many results are contained in the response.
  • The <Page> value designates how many results were skipped
  • The <TotalResults> value designates how many total results exist.