Version 1.0

Endpoints

Last Update
Single Site Field
Site History
Sites

Shared Parameters

All API Version 1.0 endpoints share the following parameters (specified in the query string):

Name Valid Values Description
FileType json, xml, tsv, csv, psv Specifies what type of data format should be returned.

FileType Descriptions

Value Name Description
json Javascript Object Notation A graph object that maps property names to object values, including all sub-properties and collections.
{"property":"value","property2":{"property2.property":"value"}}
xml Extensible Markup Language A graph object that maps property names to object values, including all sub-properties and collections.
<?xml version="1.0" encoding="utf-16"?>
<RootElement>
<Property>Value</Property>
<Property2>
<Property2.Property>Value</Property2.Property>
</Property2>
</RootElement>
csv Comma-Separated Values Returns the Items of the response in a delimited format using new lines (\r\n) as row/record delimiters and literal commas (,) as column/field delimiters. Collections and sub-objects will not be returned. Names and values containing a literal comma (,) will be escaped with the unicode sequence for a comma: \u002C.
Property,Property2
Value,Value2
tsv Tab-Separated Values Returns the Items of the response in a delimited format using new lines (\r\n) as row/record delimiters and literal tabs (\t) as column/field delimiters. Collections and sub-objects will not be returned. Names and values containing a literal tab (\t) will be escaped with the escape sequence for a tab: \t.
Property    Property2
Value   Value2
psv Pipe-Separated Values Returns the Items of the response in a delimited format using new lines (\r\n) as row/record delimiters and literal pipes (|) as column/field delimiters. Collections and sub-objects will not be returned. Names and values containing a literal pipe (|) will be escaped with the unicode sequence for a pipe: \u007C.
Property|Property2
Value|Value2

Response

All API Version 1.0 endpoint responses are wrapped in a common "wrapper" object (excepting TSV/CSV/PSV file formats). This wrapper object has the following properties:

Name Type Description
HasMore bool If true, then the request did not return all the Items.
Backoff int? If not-null, then it is expected that the caller will not call the same endpoint again until after the provided number of seconds.
IsError bool If true, then the response was an error response.
QuotaMax int Indicates how many API calls are permitted for the current caller.
QuotaRemaining int Indicates how many API calls are remaining for the current caller.
Items List<T> A list of all the items returned by the API call. The type of this list depends on the endpoint.