In this article you will learn about API Endpoints, what they are and how to use them. API Calls are very useful and quick for finding required information and data about your Phishing Campaigns, Training Courses and Recipients.
Information required for all API calls
To successfully make any API call from ReDoc, the following header information will be required for every call:
- API Key (api_key) - this is found on the Phishing Tackle platform under Setup - Organisation - Settings
- User ID (UserID)
- Organisation ID (OrganisationID)
For both the User ID and Organisation ID, please contact our support team and they will provide you with this information.
What each section should contain
Name of the API endpoint - The name of the endpoint is the title shown on ReDoc for each option, they start with 'Get' e.g. GetEmailCampaign or GetSubAccounts.
Parameters for the endpoint - The parameters for the endpoint are the query parameters which are located in ReDoc. These are shown under 'Request' attached to the endpoint you have selected.
Note: Not all endpoints have query parameters. This means that there is no query parameter for the endpoint you have selected.
An example table for the API call 'GetEmailCampaign' shown by using Power BI.
API Endpoints in depth
- For more information on how to find your Campaign ID and User ID, click here.
AllSubOrganisations
What parameters are needed?
This API Call requires no parameters and only the standard header information to make this call.
What does the endpoint return?
This endpoint returns a list of all of your sub-organisations found in your partner portal. The returned list will contain information about the Organisations ID, Name and a link to their logo.
EmailCampaigns
What parameters are needed?
This API Call requires the following parameters:
- OrganisationID
What does the endpoint return?
This endpoint returns a list of all of your Email Campaigns, with their status, start and end date.
EmailCampaignsBetweenDates
What parameters are needed?
This API Call requires the following parameters:
- OrganisationID
- Start date (Format: YYYY-MM-DDTHH:MM:SSZ)
- End date (Format: YYYY-MM-DDTHH:MM:SSZ)
- Page
What does the endpoint return?
This endpoint returns a list of Email campaigns selected from the page you input, as well as their start date, end date, status, tags, opened and clicked count.
FailedPhishingTest
What parameters are needed?
This API Call requires the following parameters:
- OrganisationID
What does the endpoint return?
The endpoint returns a list of recipients which have failed tests.
License
What parameters are needed?
This API Call requires no parameters and only the standard header information to make this call.
What does the endpoint return?
The endpoint returns information on your license, such as your term time, start date and end date.
PhishingCampaignStats
What parameters are needed?
This API Call requires the following parameters:
- OrganisationID
- SubOrgID
What does this endpoint return?
This endpoint returns the recipient count, delivered information, opened information, clicked information and replied information.
RecipientCount
What parameters are needed?
This API Call requires the following parameters:
- SubOrgID
What does the endpoint return?
The endpoint returns your recipient count, as well as the amount of active and inactive users.
RecipientStats
What parameters are needed?
This API Call requires the following parameters:
- SubOrgID
- Page
What does the endpoint return?
This endpoint returns the status of your recipients from the page you had selected.
Status
What parameters are needed?
This API Call requires no parameters and only the standard header information to make this call.
What does the endpoint return?
The endpoint returns information on your API - if it is active, online and reachable.
SubOrganisation
What parameters are needed?
The following parameters are needed:
- SubOrgID
What does the endpoint return?
The endpoint returns information on your selected SubOrg.
TrainingCampaigns
What parameters are needed?
The following parameters are needed:
- OrganisationID
What does the endpoint return?
The endpoint returns information in regards to your training campaigns such as the organisation ID, name, start and end date.
TrainingCampaignsBetweenDates
What parameters are needed?
The following parameters are needed:
- SubOrgID
- Start date (Format: YYYY-MM-DDTHH:MM:SSZ)
- End date (Format: YYYY-MM-DDTHH:MM:SSZ)
- Page
What does the endpoint return?
This endpoint returns a list of training campaigns selected from the page you input, as well as their start date, end date, status, tags, opened and clicked count.
TrainingCampaignStats
What parameters are needed?
The following parameters are needed:
- CampaignID
- OrganisationID
- Page
What does the endpoint return?
This endpoint returns a list of training campaign statuses selected from the page you input.
Please let us know if you require any further assistance, you can contact our support team by clicking here. Or by sending an email to support@phishingtackle.com