Documentation Powered by ReDoc

DataConnect Deltas (1.3.1.42)

DataConnect is a web-based connector service you can use to extract data from iQmetrix by making simple HTTP requests. It provides endpoints for common data requirements, various auth mechanisms and other utility endpoints.

Found a Mistake?

We appreciate your patience as we work to improve the documentation for DataConnect. If you have noticed a mistake or have a qustion, please let us know at apisupport [at] iqmetrix [dot] com, subject "Documentation Issue".

Common Parameters

For a complete list of parameters that are accessible to all DataConnect endpoints, see Session endpoint.

Security Protocols

We recommend that users use TLS 1.2 when connecting to DataConnect.

Error Messages

DataConnect returns standard HTTP status codes (400, 401, 403, 404, 500, 503) and readable error messages. For an example of these messages see Session endpoint.

Sign Up

To signup, contact your account manager for pricing and onboarding with DataConnect Deltas.

Authentication

bearerAuth

Bearer token. See Obtaining an Access Token

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

Customers

Customers

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

200

Successful Response

get /Delta/Customers

Release Candidate (RC)

https://dataconnectrc.iqmetrix.net/Delta/Customers

Production

https://dataconnect.iqmetrix.net/Delta/Customers

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Customers / Accounts

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

200

Successful Response

get /Delta/Customers/Accounts

Release Candidate (RC)

https://dataconnectrc.iqmetrix.net/Delta/Customers/Accounts

Production

https://dataconnect.iqmetrix.net/Delta/Customers/Accounts

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Customers / Activities

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

200

Successful Response

get /Delta/Customers/Activities

Release Candidate (RC)

https://dataconnectrc.iqmetrix.net/Delta/Customers/Activities

Production

https://dataconnect.iqmetrix.net/Delta/Customers/Activities

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Customers / Activities / Discussions

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

200

Successful Response

get /Delta/Customers/Activities/Discussions

Release Candidate (RC)

https://dataconnectrc.iqmetrix.net/Delta/Customers/Activities/Discussions

Production

https://dataconnect.iqmetrix.net/Delta/Customers/Activities/Discussions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Customers / Activities / Followups

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

200

Successful Response

get /Delta/Customers/Activities/Followups

Release Candidate (RC)

https://dataconnectrc.iqmetrix.net/Delta/Customers/Activities/Followups

Production

https://dataconnect.iqmetrix.net/Delta/Customers/Activities/Followups

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Customers / Protection

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

2