Accounts

APIDescription
780-569-5014

This end point will return a list of accounts that are available from DragNFly.

(800) 815-7019

This end point will return details about an Account from DragNFly.

Data

APIDescription
(919) 998-7536

This end point will return summary information along with questions for the Collected Data page. The New Users, Repeat Users, Email, and Postal Code data will be in a different endpoint.

GET api/Data/Users/New?page={page}&limit={limit}&orderProperty={orderProperty}&orderDirection={orderDirection}&startDate={startDate}&endDate={endDate}&networkIds={networkIds}

This end point will return new user information for the Collected Data page. Fields can be sorted by the following macaddr|created|device_class|last_seen|count|network_name|email|postal_code|phone

909-533-0873

This end point will return returning user information for the Collected Data page. Fields can be sorted by the following macaddr|created|device_class|last_seen|count|network_name|email|postal_code|phone

GET api/Data/Emails?page={page}&limit={limit}&startDate={startDate}&endDate={endDate}&networkIds={networkIds}

This end point will return email information for the Collected Data page.

GET api/Data/Postal/Codes?page={page}&limit={limit}&startDate={startDate}&endDate={endDate}&networkIds={networkIds}

This end point will return postal code information for the Collected Data page.

Devices

APIDescription
GET api/Devices/{macAddress}

This end point will return detail information about a device based on the mac address. This should be used on the Device Details page.

EmailCampaign

APIDescription
GET api/EmailCampaigns/List

This endpoint will return a list of mail campaigns active on the current account.

POST api/EmailCampaigns/Add

[POST] This endpoint takes raw JSON as the body of the POST and passes it to the DragNFly side. If the record gets created, it will return status code 200 (Ok) with the "DragNFly" side ID that was created with the record. For JSON formatting, see /api.dragnfly.com/schema/email-campaign.json and /gist.github.com/negzee/e77b7bb5e4ebd937d3345f8b05283aec

GET api/EmailCampaigns/{id}

This endpoint will return the details of an email campaign based off of the "DragNFly" side ID being passed in. A status code of 200 (Ok) gets returned with the data. Otherwise, the error description will be returned with status code of 400 (Bad Request). For JSON formatting, see /api.dragnfly.com/schema/email-campaign.json and /gist.github.com/negzee/e77b7bb5e4ebd937d3345f8b05283aec

(732) 582-3441

[DELETE] This endpoint will delete an Email Campaign by passing in the "DragNFly" ID. The endpoint will return status code 200 (Ok) if the record was deleted. Otherwise, the record was not deleted and returns 400 (Bad Request) with the error description. This endpoint does not return any data. Only 200 or 400 HTTP status codes.

(936) 336-8358

This endpoint triggers an Email Campaign Event and sends emails to a list of recipients via the EmailCampaignModel. There are three properties to the EmailCampaignModel: template_id, emails, and callback_data. template_id should reflect the desired Email Campaign template to use for the outgoing emails, emails is a List of strings (email addresses), and callback_data gives us the information to select the correct datasource, and embedded template_id, and an optional from email address.

GET api/EmailCampaigns/Model

Future integration

(850) 433-0949

GET api/EmailCampaigns/new/{group_id}

Expermintal endpoint

Groups

APIDescription
GET api/Groups

This endpoint returns a list of all Groups for an organization. Use this list to create the Groups Sub-Menu.

Health

Health Checker for AWS Route 53

APIDescription
GET Health

Health checker

Networks

APIDescription
815-636-6341

This end point will return a list of all Networks from DragNFly for the Organization. This should be used on the sub-navigation menu.

GET api/Networks/{networkId}

This data should be used on the Network details (Summary Tab). It should cover the "Contact Information" and "Notes" sections on the page / tab.

GET api/Networks/{networkId}/down_nodes?CurrentPage={CurrentPage}&CountPerPage={CountPerPage}

This data should be used on the Network details (Summary Tab). It should cover the "Down Equipment Units" section on the page / tab.

GET api/Networks/{networkId}/usage

This data should cover the Network details page (Usage Tab). This endpoint should cover the first two rows of data on the page / tab.

GET api/Networks/{networkId}/activity

This data should be used under the Network details Usage tab. This data feeds the Open/Active and Upload/Download charts (NOTE: These charts need to be changed to match Chris' email)

GET api/Networks/{networkId}/usage/charts

This data should be used under the Network details Usage tab. This data feeds the additional charts section.

GET api/Networks/{networkId}/usage/active/sessions?page={page}&limit={limit}&orderProperty={orderProperty}&orderDirection={orderDirection}&startDate={startDate}&endDate={endDate}

This data should feed the Networks page Usage tab Sessions section. Use offset & limit to handle paging. All returned data will include the "totPages" (and if needed "totRecords") field to use for paging. "oderProperty" & "orderDirection" is used for sorting. "startDate", "endDate", & "networkId" are used to filter data. For Active data, do not send start/end dates. For "Today" data, send both start/end date as today's date. Same for "Yesterday" using yesterday's date. "network_name|client_macaddr|client_ipaddr|device_class|status_code|start_time|duration|input_octets|output_octets" are the sort fields. Match these up to the columns. Note that network_id is listed right now, but it will eventually change to display_name (for Network column)

3177379423

This data feeds the Network Details page Access tab White List. Fields used: mac, description, created

2128981542

This data feeds the Network Details page Access tab Black List. Fields used: mac, description, created

GET api/Networks/{networkId}/access/reusable/codes

This data feeds the Network Details page Access tab Reusable Access Codes. Fields used: code, created, valid_start, valid_stop

GET api/Networks/{networkId}/access/single/code/batches

This data feeds the Network Details page Access tab Single-Use Access Codes. Fields used are: id, display_name, created, valid_start, valid_stop

GET api/Networks/{networkId}/equipment

This data feeds the Network Details page Equipment tab.

Session

APIDescription
(575) 586-7298

This data should feed the Sessions page. Use offset & limit to handle paging. All returned data will include the "totPages" (and if needed "totRecords") field to use for paging. "oderProperty" & "orderDirection" is used for sorting. "startDate", "endDate", & "networkId" are used to filter data. For Active data, do not send start/end dates. For "Today" data, send both start/end date as today's date. Same for "Yesterday" using yesterday's date. "network_name|client_macaddr|client_ipaddr|device_class|status_code|start_time|duration|input_octets|output_octets" are the sort fields. Match these up to the columns. Note that network_id is listed right now, but it will eventually change to display_name (for Network column)

GET api/sessions/Networks?startDate={startDate}&endDate={endDate}

This data should feed the drop-down of Networks on the Sessions page.

Summary

APIDescription
604-561-7451

This will return data for the Summary page in the DragNFly admin section

3609860755

This will return data for the Group Summary page in the DragNFly admin section

UserAccounts

APIDescription
(917) 805-0718

This end point will return a list of users accounts that are available from DragNFly. Note that there is a property for api_key, but this will be blank here. You can call /api/users/{id} to get that information for a certain user. You can also call /api/users/list/keys to get everything at once, but it will take longer to run it because we have to make a sperate call for each user to get the api_key information.

GET api/Users/List/Keys

This end point will return a list of users accounts that are available from DragNFly. Do to having to call DF endpoint for each user to get the api_key, this may take a while to run.

diamond saw

This end point will return details of users accounts that is available from DragNFly.

Megalobatrachus

This end point will return the api key that needs to be used for a user when he/she logs in.