Documentation is now available for the Fall 2020 Update release!

Integration activity

This endpoint is used to retrieve the details of an installation activity of installed integration activity.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/integrations/activity

Parameters

All of the following parameters are optional:

FieldDefault Value
pageNo={pageNo}1
pageSize={pageSize}100
isDescendingOrder={true/false}true
sortName={field}id
queryString={queryString}NA

NA indicates that the value is not applicable.

Query variables

Query VariableValuesDescription
intgMode
  • OUTBOUND
  • INBOUND
Integration mode. This specifies the inbound or outbound configuration of integration.
startTimeNA(Optional) Get the integration activities within a date range.
  • startTime indicates from date.
endTimeNA(Optional) Get the integration activities within a date range.
  • endTime indicates to date.
installedintgIdNA(Optional) Installed integration Id. To get the integration activity of a particular installed integration, provide the installed integration Id in the query parameter string.
Example: https:///api/v2/tenants/client_9/integrations/activity?queryString=startTime:2017-03-08T16:00:00 0530%2BendTime:2017-03-08T17:00:00 0530%2BinstalledintgId:INTG-bb6dcbe3-6477-42d0-8b33-4b811ad53fe3%2BIntgMode:INBOUND%2Bstatus:SUCCESS
statusSUCCESS, FAILED(Optional) Status of integration

NA indicates that the value is not applicable.

Get Integration Activity within a Date Range

Submit startDate and endDate to retrieve the integration activities within a date range.

Sample Response

Sample URL

https://{api-url}/api/v2/tenants/client_9/integrations/activity?queryString=startTime:2017-03-08T16:00:00 0530%2BendTime:2017-03-08T17:00:00 0530%2BIntgMode:INBOUND%2Bstatus:SUCCESS

Sample response

{
	"results" : [
		{
			"installedintgId" : "INTG-bb6dcbe3-6477-42d0-8b33-4b354ad53fe3",
			"intgName" : "SERVICENOW",
			"resourceId" : "",
			"resourceType" : "",
			"status" : "SUCCESS",
			"statusMessage" : "Processed successfully",
			"reqPayload" : "",
			"resPayload" : "{"pageSize":0,"nextPage":false,"descendingOrder":false}",
			"requestUrl" : "https://<api-url>/api/v2/tenants/client_9/intg/activity/intgActivity?queryString=startTime:2017-03-08T16:00:00%200530%2BendTime:2017-03-08T17:00:00%200530%2BIntgMode:INBOUND",
			"intgMode" : "INBOUND",
			"processedTime" : 1488970355393
		},
		{
			"installedintgId" : "INTG-bb6dcbe3-6477-42d0-8b33-4b387ad53fe3",
			"intgName" : "CUSTOM",
			"resourceId" : "",
			"resourceType" : "",
			"status" : "SUCCESS",
			"statusMessage" : "Processed successfully",
			"reqPayload" : "",
			"resPayload" : "{"pageSize":0,"nextPage":false,"descendingOrder":false}",
			"requestUrl" : "https://<api-url>/api/v2/tenants/client_9/intg/activity/intgActivity?queryString=startTime:2017-03-08T04:00:00%200530%2BendTime:2017-03-08T05:00:00%200530%2BIntgMode:INBOUND",
			"intgMode" : "INBOUND",
			"processedTime" : 1488970300924
		},
		{
			"installedintgId" : "INTG-bb6dcbe3-6477-42d0-8b33-4b854ed53fe3",
			"intgName" : "CUSTOM",
			"resourceId" : "",
			"resourceType" : "",
			"status" : "SUCCESS",
			"statusMessage" : "Processed successfully",
			"reqPayload" : "",
			"resPayload" : "{"pageSize":0,"nextPage":false,"descendingOrder":false}",
			"requestUrl" : "https://<api-url>/api/v2/tenants/client_9/intg/activity/intgActivity?queryString=startTime:2017-03-08T04:00:00%200530%2BendTime:2017-03-08T05:00:00%200530%2BIntgMode:INBOUND",
			"intgMode" : "INBOUND",
			"processedTime" : 1488970299546
		},
		{
			"installedintgId" : "INTG-bb6dcbe3-6477-429o-8b33-4fe451ad54df7",
			"intgName" : "CUSTOM",
			"resourceId" : "",
			"resourceType" : "",
			"status" : "SUCCESS",
			"statusMessage" : "Processed successfully",
			"reqPayload" : "",
			"resPayload" : "{"pageSize":0,"nextPage":false,"descendingOrder":false}",
			"requestUrl" : "https://<api-url>/api/v2/tenants/client_9/intg/activity/intgActivity?queryString=startTime:2017-03-08T04:00:00%200000%2BendTime:2017-03-08T05:00:00%200000%2BIntgMode:INBOUND",
			"intgMode" : "INBOUND",
			"processedTime" : 1488970263464
		},
		{
			"installedintgId" : "INTG-bb3efce3-6477-42d0-5c42-5c767ad54hd3",
			"intgName" : "CUSTOM",
			"resourceId" : "",
			"resourceType" : "",
			"status" : "SUCCESS",
			"statusMessage" : "Processed successfully",
			"reqPayload" : "",
			"resPayload" : "{"pageSize":0,"nextPage":false,"descendingOrder":false}",
			"requestUrl" : "https://<api-url>/api/v2/tenants/client_9/intg/activity/intgActivity?queryString=startTime:2017-03-08T04:00:00%200530%2BendTime:2017-03-08T05:00:00%200530%2BIntgMode:INBOUND",
			"intgMode" : "INBOUND",
			"processedTime" : 1488970237096
		},
		{
			"installedintgId" : "INTG-bb6dcbe3-6477-42d0-9ec3-6rc76dc59fc5",
			"intgName" : "FRESHSERVICE",
			"resourceId" : "",
			"resourceType" : "",
			"status" : "SUCCESS",
			"statusMessage" : "Processed successfully",
			"reqPayload" : "",
			"resPayload" : "{"pageSize":0,"nextPage":false,"descendingOrder":false}",
			"requestUrl" : "https://<api-url>/api/v2/tenants/client_9/intg/activity/intgActivity?queryString=startTime:2017-03-08T04:00:00%200530%2BendTime:2017-03-08T05:00:00%200530%2BIntgMode:INBOUND",
			"intgMode" : "INBOUND",
			"processedTime" : 1488970235663
		},
		{
			"installedintgId" : "INTG-bb3edbe3-6477-42d0-8c56-4c532df25cf5",
			"intgName" : "JIRA",
			"resourceId" : "",
			"resourceType" : "",
			"status" : "SUCCESS",
			"statusMessage" : "Processed successfully",
			"reqPayload" : "",
			"resPayload" : "{"pageSize":0,"nextPage":false,"descendingOrder":false}",
			"requestUrl" : "https://<api-url>/api/v2/tenants/client_9/intg/activity/intgActivity?queryString=startTime:2017-03-08T04:00:00%200530%2BendTime:2017-03-08T05:00:00%200530",
			"intgMode" : "INBOUND",
			"processedTime" : 1488970153650
		},
		{
			"installedintgId" : "INTG-bb6dcbe3-6599-42d0-8c33-4b811ae5673r",
			"intgName" : "CUSTOM",
			"resourceId" : "",
			"resourceType" : "",
			"status" : "SUCCESS",
			"statusMessage" : "Processed successfully",
			"reqPayload" : "",
			"resPayload" : "{"pageSize":0,"nextPage":false,"descendingOrder":false}",
			"requestUrl" : "https://<api-url>/api/v2/tenants/client_9/intg/activity/intgActivity?queryString=startTime:2017-03-08T12:00:00%200530%2BendTime:2017-03-08T12:30:00%200530",
			"intgMode" : "INBOUND",
			"processedTime" : 1488969867751
		},
		{
			"installedintgId" : "INTG-bg5fcbe3-6477-42d0-4c33-4b45re313r4r",
			"intgName" : "JIRA",
			"resourceId" : "",
			"resourceType" : "",
			"status" : "SUCCESS",
			"statusMessage" : "Processed successfully",
			"reqPayload" : "",
			"resPayload" : "{"pageSize":0,"nextPage":false,"descendingOrder":false}",
			"requestUrl" : "https://<api-url>/api/v2/tenants/client_9/intg/activity/intgActivity?queryString=startTime:2017-03-08T12:00:00%200530%2BendTime:2017-03-08T12:30:00%200530",
			"intgMode" : "INBOUND",
			"processedTime" : 1488969866264
		},
		{
			"installedintgId" : "INTG-bb6dbed3-4325-52do-5b33-4dc22bc45ge5",
			"intgName" : "CUSTOM",
			"resourceId" : "",
			"resourceType" : "",
			"status" : "SUCCESS",
			"statusMessage" : "Processed successfully",
			"reqPayload" : "",
			"resPayload" : "{"pageSize":0,"nextPage":false,"descendingOrder":false}",
			"requestUrl" : "https://<api-url>/api/v2/tenants/client_9/intg/activity/intgActivity?queryString=startTime:2017-03-08T12:00:00%200530%2BendTime:2017-03-08T12:30:00%200530",
			"intgMode" : "INBOUND",
			"processedTime" : 1488969822870
		}
	],
	"totalResults" : 10,
	"pageNo" : 1,
	"pageSize" : 100,
	"totalPages" : 1,
	"nextPage" : false,
	"descendingOrder" : false
}

Get Integration Activity within a Date Range

Provide pageNo and pageSize to view a specific number of integration activities on a page.

Sample URL

https://{api-url}/api/v2/tenants/client_9/integrations/activity?pageNo=1&pageSize=10&queryString=IntgMode:OUTBOUND%2Bstatus:SUCCESS

Sample response

{
	"results" : [
		{
			"installedintgId" : "INTG-e26429c2-7f1a-4cd6-a714-851365e2bdae",
			"intgName" : "",
			"resourceId" : "",
			"resourceType" : "ALERT",
			"status" : "COMPLETE",
			"statusMessage" : "Processed successfully",
			"reqPayload" : "{"serviceName":"CPU","device":{"hostName":"Think-pad","resourceUUID":"DEV0000011767","providerUUID":"11767","systemUUID":"11767","macAddress":"2E:8B:EB:32:7A:F9","ipAddress":"192.156.255.251"},"subject":"Test API Alert sensu 2","alertTime":"2014-11-05 11:26:00","currentState":"OK","app":"NEWRELIC","alertType":"Maintenance","component":"C","description":"api calls","monitorName":"test"}",
			"resPayload" : "",
			"requestUrl" : "https://192.168.56.121/api/v2/tenants/client_9/alert",
			"intgMode" : "INBOUND",
			"processedTime" : 1488961814334
		},
		{
			"installedintgId" : "INTG-e26429c2-7f1a-4cd6-a714-851365e2bdae",
			"intgName" : "",
			"resourceId" : "",
			"resourceType" : "ALERT",
			"status" : "COMPLETE",
			"statusMessage" : "Processed successfully",
			"reqPayload" : "{"serviceName":"CPU","device":{"hostName":"Think-pad","resourceUUID":"DEV0000011767","providerUUID":"11767","systemUUID":"11767","macAddress":"2E:8B:EB:32:7A:F9","ipAddress":"192.156.255.251"},"subject":"Test API Alert sensu 1","alertTime":"2014-11-05 11:26:00","currentState":"CRITICAL","app":"NEWRELIC","alertType":"Maintenance","component":"C","description":"api calls","monitorName":"test"}",
			"resPayload" : "",
			"requestUrl" : "https://192.168.56.121/api/v2/tenants/client_9/alert",
			"intgMode" : "INBOUND",
			"processedTime" : 1488961772629
		},
		{
			"installedintgId" : "INTG-e26429c2-7f1a-4cd6-a714-851365e2bdae",
			"intgName" : "",
			"resourceId" : "",
			"resourceType" : "ALERT",
			"status" : "COMPLETE",
			"statusMessage" : "Processed successfully",
			"reqPayload" : "{"serviceName":"CPU","device":{"hostName":"Think-pad","resourceUUID":"DEV0000011767","providerUUID":"11767","systemUUID":"11767","macAddress":"2E:8B:EB:32:7A:F9","ipAddress":"192.156.255.250"},"subject":"Test API Alert sensu 1","alertTime":"2014-11-05 11:26:00","currentState":"CRITICAL","app":"NEWRELIC","alertType":"Maintenance","component":"C","description":"api calls","monitorName":"test"}",
			"resPayload" : "",
			"requestUrl" : "https://192.168.56.121/api/v2/tenants/client_9/alert",
			"intgMode" : "INBOUND",
			"processedTime" : 1488961738352
		},
		{
			"installedintgId" : "INTG-b2e9808e-7457-469f-b6a1-c76393facfe8",
			"intgName" : "test",
			"resourceId" : "INC0000000347",
			"resourceType" : "INCIDENT",
			"status" : "COMPLETE",
			"statusMessage" : "Incident processed COMPLETE",
			"reqPayload" : "test tkt ",
			"resPayload" : "",
			"requestUrl" : "",
			"intgMode" : "INBOUND",
			"processedTime" : 1488892849283
		},
		{
			"installedintgId" : "INTG-b2e9808e-7457-469f-b6a1-c76393facfe8",
			"intgName" : "test",
			"resourceId" : "INC0000000346",
			"resourceType" : "INCIDENT",
			"status" : "COMPLETE",
			"statusMessage" : "Response Updated",
			"reqPayload" : "test from api 6",
			"resPayload" : "",
			"requestUrl" : "",
			"intgMode" : "INBOUND",
			"processedTime" : 1488799767447
		},
		{
			"installedintgId" : "INTG-b2e9808e-7457-469f-b6a1-c76393facfe8",
			"intgName" : "test",
			"resourceId" : "INC0000000346",
			"resourceType" : "INCIDENT",
			"status" : "COMPLETE",
			"statusMessage" : "Response Updated",
			"reqPayload" : "test from api 6",
			"resPayload" : "",
			"requestUrl" : "",
			"intgMode" : "INBOUND",
			"processedTime" : 1488799765657
		},
		{
			"installedintgId" : "INTG-b2e9808e-7457-469f-b6a1-c76393facfe8",
			"intgName" : "test",
			"resourceId" : "INC0000000346",
			"resourceType" : "INCIDENT",
			"status" : "COMPLETE",
			"statusMessage" : "Response Updated",
			"reqPayload" : "test from api 6",
			"resPayload" : "",
			"requestUrl" : "",
			"intgMode" : "INBOUND",
			"processedTime" : 1488799763713
		},
		{
			"installedintgId" : "INTG-b2e9808e-7457-469f-b6a1-c76393facfe8",
			"intgName" : "test",
			"resourceId" : "INC0000000346",
			"resourceType" : "INCIDENT",
			"status" : "COMPLETE",
			"statusMessage" : "Response Updated",
			"reqPayload" : "test from api 6",
			"resPayload" : "",
			"requestUrl" : "",
			"intgMode" : "INBOUND",
			"processedTime" : 1488799761865
		},
		{
			"installedintgId" : "INTG-b2e9808e-7457-469f-b6a1-c76393facfe8",
			"intgName" : "test",
			"resourceId" : "INC0000000346",
			"resourceType" : "INCIDENT",
			"status" : "COMPLETE",
			"statusMessage" : "Response Updated",
			"reqPayload" : "test from api 6",
			"resPayload" : "",
			"requestUrl" : "",
			"intgMode" : "INBOUND",
			"processedTime" : 1488798121233
		},
		{
			"installedintgId" : "INTG-b2e9808e-7457-469f-b6a1-c76393facfe8",
			"intgName" : "test",
			"resourceId" : "INC0000000346",
			"resourceType" : "INCIDENT",
			"status" : "COMPLETE",
			"statusMessage" : "Response Updated",
			"reqPayload" : "test from api 6",
			"resPayload" : "",
			"requestUrl" : "",
			"intgMode" : "INBOUND",
			"processedTime" : 1488798117365
		}
	],
	"totalResults" : 31,
	"pageNo" : 1,
	"pageSize" : 10,
	"totalPages" : 4,
	"nextPage" : true,
	"nextPageNo" : 2,
	"descendingOrder" : false
}