Open Tracking Dashboard

This endpoint allows you to open the file tracking dashboard. This can be useful if you want to quickly enable file-tracking within your application without having to build out your own interface. This is typically used for error display & acknowledgement.

Information Circle

Key Benefits:

  • Users do not need to separately login – they can open UIs already logged in and browsed directly to the data that they require
  • The UI is cut down from the full dashboard – only showing users basic details
  • You can quickly build out your integration with the Xtracta App and your application – while maintaining an interface which feels as if it is part of what the user is used to (using the re-branding capabilities of the Xtracta App)

POST Parameters

ParameterRequiredValueDescription
api_key{key}An API key that has access to the resource you want to query for
workflow_id{integer}The ID of the workflow you wish to open the tracking dashboard for
document_id{integer}The ID of the document you wish to open the tracking dashboard for
statusok, errorThe status of the documents you wish to show. Usually this is set to error
typeemail, ftp, web, apiChoose how to filter results based on how items entered the system (input method)
expire{integer}The length of time the returned URL will be valid (in seconds). Max: 86400, Default: 600
page{integer}Page number to open on initial load
items_per_page{integer}Maximum items per page. Default: 10, Max: 100
start_datetime{string}Enter the start date and time in ISO 8601 format (e.g., 2018-01-01T01:00:00+13:00), including the timezone offset
end_datetime{string}Enter the end date and time in ISO 8601 format (e.g., 2018-01-01T01:00:00+13:00), including the timezone offset
time_coversTimeReceived, TimeActivitySpecifies the time reference used for the record. Options include 'TimeReceived' (default) and 'TimeActivity'. If no value is selected, 'TimeReceived' is used by default.
orderasc, desc, {null}Sort order based on received dates (older first or newer first)
timezone{php timezone}Timezone for returned datetimes. All standard PHP timezones are supported. Defaults to UTC
learning1, {null}Set to "1" to get the tracking activities of documents used for learning
Information Circle

Important Requirements:

  • Either workflow_id OR document_id must be provided (⚠️ indicates at least one is required)
  • This endpoint is typically used for error display & acknowledgement

Response Information

ElementDescription
<status>A status code in response to the operation.
<message>Additional human-readable info about the operation.
<url>The unique URL to open the dashboard that is pre-logged in.
<expire>The time the URL will expire, expressed in UNIX time.

Sample Request

POST https://api-app.xtracta.com/v1/tracking/ui HTTP/1.1
api_key=123&workflow_id=512&status=error

Sample Response

<?xml version="1.0" encoding="UTF-8"?>
<tracking_response>
    <status>200</status>
    <message>The request has been successfully processed</message>
    <url>https://api-app.xtracta.com/v1/documents/index.html?t=jP9fL78S3BqBunXoYmtrZN4M_Ej71XJw7EMQ4l_B39mEZvAmkYR8ycaliLNSHRzVvhaptfJxEACkIddYpi8xKkoyVnyYqT0qbBScMvOqEjq0r6Q8cyCOa6B3OBYqDIzKZ0oEvLQ1BktBCecBtMYJzDXB3dPz3BjYeMei5PvaGe5uPVSvKu9yHmgCvH5FmAK_MhG5xy.Ur92EfpJRb3gbYaaG.y8aLUvmWYnDRmALqsIDlang_Ee8VPujcdZO5A5VCtNDae1jnMmDVjDLQ_QhbM2b.4a8Mw5v8gxTl2.8ZHb3S4DvqJcAbCMSzQoJLtgv</url>
    <expire>1425898940</expire>
</tracking_response>

Schema Definition

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">

  <xs:simpleType name="ConfidenceType">
    <xs:union>
      <xs:simpleType>
        <xs:restriction base="xs:integer">
          <xs:minInclusive value="0"/>
          <xs:maxInclusive value="100"/>
        </xs:restriction>
      </xs:simpleType>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value=""/>
        </xs:restriction>
      </xs:simpleType>
    </xs:union>
  </xs:simpleType>

  <xs:complexType name="TrackingresponseType">
    <xs:sequence>
      <xs:element name="status" type="xs:integer" minOccurs="0"/>
      <xs:element name="message" type="xs:string" minOccurs="0"/>
      <xs:element name="url" type="xs:anyURI" minOccurs="0"/>
      <xs:element name="expire" type="xs:integer" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>

  <xs:element name="tracking_response">
    <xs:complexType>
      <xs:sequence>
      <xs:element name="status" type="xs:integer" minOccurs="0"/>
      <xs:element name="message" type="xs:string" minOccurs="0"/>
      <xs:element name="url" type="xs:anyURI" minOccurs="0"/>
      <xs:element name="expire" type="xs:integer" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

</xs:schema>