WorkSpan Report API

API for WorkSpan Reports

Get report data

Returns real-time report data (paginated). Good for small reports (<10K rows) because no preparation step is required. Usable for bigger reports too with the risk of missing or ghost rows due to concurrent updates going in the same time.

Try it

Request

Request URL

https://api-sandbox.workspan.com/report/v1/{reportId}/data

Request parameters

reportId

integer

Format - int64.

Request headers

Authorization

string

Format: bearer $
Content-Type (optional)

string

Media type of the body sent to the API.

Request body

application/json

{
  "filters": {
    "op": "AND",
    "group": [
      {
        "op": "OR",
        "group": [],
        "fieldFilters": [
          {
            "type": "TEXT",
            "colId": "0",
            "filter": {
              "op": "EQUAL_TO",
              "negate": false,
              "values": [
                "CREATE_FAILED"
              ]
            }
          },
          {
            "type": "TEXT",
            "colId": "0",
            "filter": {
              "op": "EQUAL_TO",
              "negate": false,
              "values": [
                "UPDATE_FAILED"
              ]
            }
          }
        ]
      }
    ],
    "fieldFilters": [
      {
        "type": "TEXT",
        "colId": "1",
        "filter": {
          "op": "EQUAL_TO",
          "negate": true,
          "values": [
            "FAILED"
          ]
        }
      }
    ]
  },
  "page": {
    "number": 0,
    "size": 100
  }
}

Responses

200 OK

Representations

application/json

Sample
Schema

{
  "version": 5,
  "endOfList": false,
  "results": [
    {
      "CRM ID": 1234,
      "Country": "US",
      "Region": "North"
    },
    {
      "CRM ID": 1564,
      "Country": "US",
      "Region": "South"
    }
  ]
}

{
  "type": "object",
  "properties": {
    "version": {
      "type": "integer",
      "format": "int64",
      "example": 5
    },
    "endOfList": {
      "type": "boolean",
      "example": false
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": {
          "type": "object"
        }
      },
      "example": [
        {
          "CRM ID": 1234,
          "Country": "US",
          "Region": "North"
        },
        {
          "CRM ID": 1564,
          "Country": "US",
          "Region": "South"
        }
      ]
    }
  }
}

400 Bad Request

Bad Request

Representations

application/json

401 Unauthorized

Authorization Error

Representations

application/json

404 Not Found

WorkSpan object Not Found

Representations

application/json

500 Internal Server Error

Internal Server Error

Representations

application/json

Code samples

@ECHO OFF

curl -v -X POST "https://api-sandbox.workspan.com/report/v1/{reportId}/data"
-H "Authorization: "
-H "Content-Type: application/json"

--data-ascii "{body}"

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Authorization", "");

            var uri = "https://api-sandbox.workspan.com/report/v1/{reportId}/data?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}

// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api-sandbox.workspan.com/report/v1/{reportId}/data");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Authorization", "");
            request.setHeader("Content-Type", "application/json");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api-sandbox.workspan.com/report/v1/{reportId}/data?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Authorization","");
                xhrObj.setRequestHeader("Content-Type","application/json");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api-sandbox.workspan.com/report/v1/{reportId}/data";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"Authorization"];
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api-sandbox.workspan.com/report/v1/{reportId}/data');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Authorization' => '',
    'Content-Type' => 'application/json',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>

########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Authorization': '',
    'Content-Type': 'application/json',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api-sandbox.workspan.com')
    conn.request("POST", "/report/v1/{reportId}/data?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Authorization': '',
    'Content-Type': 'application/json',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api-sandbox.workspan.com')
    conn.request("POST", "/report/v1/{reportId}/data?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

require 'net/http'

uri = URI('https://api-sandbox.workspan.com/report/v1/{reportId}/data')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body