How to download a view via API

You have to do a POST call, and specify the view in the payload.

Here’s how I accomplish that:

 var payloadData = JSON.stringify({
    "ProductId": {ProductId},
    "Filters": [
      {
        "Facet": "View",
        "Id": {ViewId}
      }
    ]
  });
  var url = "https://{yourschool}.incidentiq.com/api/v1.0/users?$s={number of results per page}"; // to avoid having to script out looping through pages, I usually just set this number insanely high, like 99999, and get all my results on one page. This works as long as you don't hit a limit with the size of JSON file you have to parse through. I think Google Apps Script has a 50MB limit or something
  var options = {
    method: 'POST',
    headers: {
      "SiteId": {Your site ID},
      "Authorization": "Bearer {your API key}",
      "Pragma": "no-cache",
      "Accept": "application/json, text/plain, */*",
      "Client": "WebBrowser",
      "Accept-Encoding": "gzip, deflate",
      "Content-Type": "application/json",
    },
    payload: payloadData,
    redirect: 'follow',
    muteHttpExceptions: true
  };

From there you just have to parse your response out however you want it.

Hey Everyone! 

I hope you are both doing well so far today! My name is Drew Thaxton, I am a Customer Support Specialist at Incident IQ who specializes in helping with our API calls, and I just wanted to reach back out to confirm that the API call provided by @jclark should be the correct call you will want to use to pull the users returned by a custom view! Below I also went ahead and supplied this call as well but in cURL if that may be beneficial. Please note that for the words contained in brackets, your district will want to replace the bracketed words with that information it specifies for your district.

curl --location 'https://{SITE}.incidentiq.com/api/v1.0/users?%24s=20&%24o=FullName%20ASC' \
--header 'accept: application/json, text/plain, */*' \
--header 'accept-language: en-US,en;q=0.9' \
--header 'client: WebBrowser' \
--header 'content-type: application/json' \
--header 'productid: 88df910c-91aa-e711-80c2-0004ffa00010' \
--header 'siteid: {SITEID}' \
--header 'user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36' \
--header 'Authorization: Bearer {TOKEN}' \
--data '{"OnlyShowDeleted":false,"Filters":[{"Facet":"View","Id":"{VIEWID}"}]}'

Best, 
Drew

Hello.
No, I’m not trying to pull users from a View.  I’m trying to pull Assets data from a View.

Is there a location in the API docs that explains this?  I only see lists views and get details on a view.  Nothing about pulling the results of a view.

Your original post linked a user view, so that was my assumption - sorry about that.

The calls mentioned are the same you would just replace “users” with “assets” in the endpoint URL and the rest will work the same just as Drew mentioned.

I had a complaint about the API documentation myself. The old documentation, while being hard to follow, listed WAY more endpoints that you could use. What’s published now seems better for reading, but is incredibly inconclusive when it comes to the available endpoints you can use.

Hi,

@jclark is there a way to get around the limit of the JSON file?

I’m using the API call you provided in Postman, but using $s=99999 gives me an error saying “Maximum response size reached”. The view I’m trying to call includes over 19000 users. Even adjusting to 20000 still causes the error and I’d like to be able to pull all the results in one call, if that’s even possible.

@jclark Looks like increasing the limit in Postman did the trick. I appreciate your assistance and for providing all the detailed and insightful info.

Great job @jclark! @JBauer 693f843 mva Glad you were able to get this figured out 😄