Boards API

 

The Boards endpoint returns the boards a specific user token has access to. This can be used to pull a list of boards to in turn pass to the analytics_reports API. This is the same list of boards that populates the user’s navigation menu in the SimpleReach app.

Resource URI:

This URL applies to all documentation below and is only accessible by a GET request over HTTPS.

https://data.simplereach.com/v1/boards 

Authentication:

The API is authenticated via header information. These values will be given to you by your Customer Success Manager, both are required.

Keys

SRTOKEN || Access token applies to an individual user.

SRAPPKEY || Application key applies to an organization.


Parameters:

limit || Number of results per page. Default is 30, maximum is 1000.

page || Used to paginate through results.

sort || Indicates which field in the result set to sort results by, eg type or -type.


Errors:

SimpleReach uses conventional HTTP response codes to indicate success and failure of the API call. In general, codes in the 200’s are successful, codes in the 400’s represent an error in how the API was called, and codes in the 500’s represent internal failures with SimpleReach systems.

 

Codes

200 || Worked as expected.

401 || Unauthorized request. There was a problem authenticating or you are requesting information from a board that the user token does not have access to. Check that your SRAPPKEY and SRTOKEN are correct and provided as header attributes -- and that you can access the same board on the application front end.

422 || Invalid values were passed to the API.

500 || Internal server error with SimpleReach systems. We would appreciate reporting any 500 errors to your Customer Success Manager. Include the time(s) the request was made, exact URL or request including all parameters, HTTP response code, error message (if available), and the SRTOKEN and SRAPPKEY used when you report the problem.

504 || The request has timed out. In most cases if you retry the request will be successful. It is recommended to build retry logic into any automated API interactions.

 

Errors can happen for many reasons. It is recommended that you write code that gracefully handles error conditions and retries on common traffic and network-related errors such as timeouts.
 
Report any errors that you cannot recover from via retry to your SimpleReach Customer Success Manager. Please be sure to include the following when reporting any problems: time(s) the request was made, exact URL or request including all parameters, HTTP response code, error message (if available), and the SRTOKEN and SRAPPKEY used.
 


Example Usage: 

The most common use case is to return all boards assigned to a user’s token:

 https://data.simplereach.com/v1/boards 

Here is an example requesting the second page of a request that has more results than the stated limit:

 https://data.simplereach.com/v1/boards
            ?page=2 

Versioning:

Any destructive changes to APIs will be versioned, followed by a deprecation period of the previous version. Structural changes, including removing fields, will be considered destructive. Adding a new field will not be considered a destructive change.