Skip to content
  • There are no suggestions because the search field is empty.

Get Historical Data for Company API Route

This route will return historical user data about this company for the last 12 months.

Response Reference

Field Type Example
companyHistoricalData array[historicalUserRecord] [{[{ phinId: “sampleId”, firstName: “Josh”, lastName: “Simmons”, emailAddress: “josh@phinsecurity.com”, phishesSent: 0, phishesClicked: 0, phishingClickPercentage:0, trainingsAssigned:0, trainingsCompleted:0, upToDateOnTraining: true }]

Response Sample

{
	companyHistoricalData: [{
		phinId: “sampleId”,
		firstName: “Hsoj”,
		lastName:  “Snommis”,
		emailAddress: “hosj@phinsecurity.com”,
		phishesSent: 0,
		phishesClicked: 0,
		phishingClickPercentage:0,
		trainingsAssigned:0,
		trainingsCompleted:0,
		upToDateOnTraining: true
	}]
}

Error Reference

Code Message Explanation
400 Failed to validate the authenticity of this request. In addition to the generic version of this error relating to an incorrect PartnerId, you may have provided an incorrect CompanyId.
500 Failed to get historical data for company. Something went wrong fetching the inventory of companies. Try again later or contact Phin.