Freenalytics API (1.0.1)

Download OpenAPI specification:Download

This site contains the documentation for the Freenalytics API.

Auth

This section contains the supported operations for Auth.

Check if user registration is enabled.

Check if user registration is enabled on the server. If it is disabled, users will not be able to register new accounts.

Responses

Response samples

200

Content type

application/json

{"value": {"success": true,
"status": 200,
"data": {"open": true
}
}
}

Register a new user account.

Register a new user account. This route will only work if the server has enabled user registration.

Request Body schema: application/json

Request body for RegisterRequestSchema.

username required	string [ 3 .. 20 ] characters ^[\w._-]*$
password required	string >= 8 characters
locale required	string Value: "en"

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "stringst",
"locale": "en"
}

Response samples

201
400
401
403

Content type

application/json

{"value": {"success": true,
"status": 200,
"data": {"message": "xrvy3n0n3v"
}
}
}

Login with your user account.

Login with your user account. Responds with a bearer token to authenticate further requests.

Request Body schema: application/json

Request body for LoginRequestSchema.

username required	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string"
}

Response samples

200
401

Content type

application/json

{"value": {"success": true,
"status": 200,
"data": {"token": "actzhf70hb"
}
}
}

Change your user account password.

Authorizations:

bearer_token

Request Body schema: application/json

Request body for ChangePasswordRequestSchema.

old_password required	string
new_password required	string

Responses

Request samples

Payload

Content type

application/json

{"old_password": "string",
"new_password": "string"
}

Response samples

200
401
404

Content type

application/json

{"value": {"success": true,
"status": 200,
"data": {"message": "b6hwc4iu7eu"
}
}
}

User

This section contains the supported operations for User.

Get all users.

Get all registered users in the platform.

Authorizations:

bearer_token

Responses

Response samples

200
401

Content type

application/json

{"value": {"success": true,
"status": 200,
"data": [{"username": "0xgl684q5upd",
"locale": "en",
"createdAt": "2022-12-07T02:02:48.195Z",
"lastModifiedAt": "2022-12-07T02:02:48.195Z"
},
{"username": "xntpckhm89",
"locale": "en",
"createdAt": "2022-12-07T02:02:48.197Z",
"lastModifiedAt": "2022-12-07T02:02:48.197Z"
},
{"username": "5vqaw6d0k24",
"locale": "en",
"createdAt": "2022-12-07T02:02:48.201Z",
"lastModifiedAt": "2022-12-07T02:02:48.201Z"
}
]
}
}

Get the current user.

Get the user information for the requesting user.

Authorizations:

bearer_token

Responses

Response samples

200
401

Content type

application/json

{"value": {"success": true,
"status": 200,
"data": {"username": "0s266vvv2wcb",
"locale": "en",
"createdAt": "2022-12-07T02:02:48.183Z",
"lastModifiedAt": "2022-12-07T02:02:48.183Z"
}
}
}

Update the current user.

Update the user information for the requesting user.

Authorizations:

bearer_token

path Parameters

username

required

string

The username of the user to get.

Request Body schema: application/json

Request body for UserUpdateRequestSchema.

locale

string

Value: "en"

Responses

Request samples

Payload

Content type

application/json

{"locale": "en"
}

Response samples

200
400
401

Content type

application/json

{"value": {"success": true,
"status": 200,
"data": {"username": "0s266vvv2wcb",
"locale": "en",
"createdAt": "2022-12-07T02:02:48.183Z",
"lastModifiedAt": "2022-12-07T02:02:48.183Z"
}
}
}

Get a user by their username.

Authorizations:

bearer_token

path Parameters

username

required

string

The username of the user to get.

Responses

Response samples

200
401
404

Content type

application/json

{"value": {"success": true,
"status": 200,
"data": {"username": "0s266vvv2wcb",
"locale": "en",
"createdAt": "2022-12-07T02:02:48.183Z",
"lastModifiedAt": "2022-12-07T02:02:48.183Z"
}
}
}

Application

This section contains the supported operations for Application.

Get all applications for the requesting user.

Authorizations:

bearer_token

Responses

Response samples

200
401

Content type

application/json

{"value": {"success": true,
"status": 200,
"data": [{"name": "scroygsu8jq",
"owner": "b0mjzyuldkv",
"domain": "d69jf0n3er",
"type": "web",
"connectors": [{"package_url": "ftp://www.mqatasuaqn7.gov",
"language": "4z52bqhl9n9"
}
],
"template": {"raw_schema": "h7u44t13jmp",
"schema": {"type": "object",
"properties": { },
"required": ["z61jmmxhcyl"
]
}
},
"createdAt": "2022-12-07T02:02:48.261Z",
"lastModifiedAt": "2022-12-07T02:02:48.261Z"
},
{"name": "6hchji4hvxc",
"owner": "uo5ektw3ahn",
"domain": "lu06t9uzytr",
"type": "mobile",
"connectors": [{"package_url": "http://www.y1i19l7prx.com",
"language": "kvp8ga3hcgd"
}
],
"template": {"raw_schema": "e2nukbuykps",
"schema": {"type": "object",
"properties": { },
"required": ["xxcmnlt8twf"
]
}
},
"createdAt": "2022-12-07T02:02:48.273Z",
"lastModifiedAt": "2022-12-07T02:02:48.273Z"
},
{"name": "8xp5ji7aohg",
"owner": "k6brcdbwkib",
"domain": "rzz6vsg1ilm",
"type": "web",
"connectors": [{"package_url": "https://www.o6dwgnvq6l.gov",
"language": "gxlnoxzvbtt"
}
],
"template": {"raw_schema": "fc05up27cjd",
"schema": {"type": "object",
"properties": { },
"required": ["myxuzz48oaq"
]
}
},
"createdAt": "2022-12-07T02:02:48.289Z",
"lastModifiedAt": "2022-12-07T02:02:48.289Z"
}
]
}
}

Create a new application for the requesting user.

Create a new application for the requesting user. The schema field in the request body should be a valid JSON Schema that describes the data that will be uploaded in the future.

Authorizations:

bearer_token

Request Body schema: application/json

Request body for ApplicationCreateRequestSchema.

name required	string
type required	string Enum: "mobile" "web" "server" "desktop" "other"
schema required	string
	Array of objects Default: []

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"type": "mobile",
"schema": "string",
"connectors": [ ]
}

Response samples

201
400
401

Content type

application/json

{"value": {"success": true,
"status": 200,
"data": {"name": "e7bg5yjyafj",
"owner": "mmfapuakm9",
"domain": "qeuszoo5jvg",
"type": "other",
"connectors": [{"package_url": "https://www.w92opi5csdp.gov",
"language": "2v7abbrqmy5"
}
],
"template": {"raw_schema": "arv34nih9qu",
"schema": {"type": "object",
"properties": { },
"required": ["pmx9u4pydac"
]
}
},
"createdAt": "2022-12-07T02:02:48.253Z",
"lastModifiedAt": "2022-12-07T02:02:48.253Z"
}
}
}

Get an application by domain for the requesting user.

Authorizations:

bearer_token

path Parameters

domain

required

string

The domain of the application to get.

Responses

Response samples

200
401
404

Content type

application/json

{"value": {"success": true,
"status": 200,
"data": {"name": "e7bg5yjyafj",
"owner": "mmfapuakm9",
"domain": "qeuszoo5jvg",
"type": "other",
"connectors": [{"package_url": "https://www.w92opi5csdp.gov",
"language": "2v7abbrqmy5"
}
],
"template": {"raw_schema": "arv34nih9qu",
"schema": {"type": "object",
"properties": { },
"required": ["pmx9u4pydac"
]
}
},
"createdAt": "2022-12-07T02:02:48.253Z",
"lastModifiedAt": "2022-12-07T02:02:48.253Z"
}
}
}

Update an application by domain for the requesting user.

Authorizations:

bearer_token

path Parameters

domain

required

string

The domain of the application to update.

Request Body schema: application/json

Request body for ApplicationUpdateRequestSchema.

name	string
type	string Enum: "mobile" "web" "server" "desktop" "other"
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"type": "mobile",
"connectors": [{"package_url": "http://example.com",
"language": "string"
}
]
}

Response samples

200
400
401
404

Content type

application/json

{"value": {"success": true,
"status": 200,
"data": {"name": "e7bg5yjyafj",
"owner": "mmfapuakm9",
"domain": "qeuszoo5jvg",
"type": "other",
"connectors": [{"package_url": "https://www.w92opi5csdp.gov",
"language": "2v7abbrqmy5"
}
],
"template": {"raw_schema": "arv34nih9qu",
"schema": {"type": "object",
"properties": { },
"required": ["pmx9u4pydac"
]
}
},
"createdAt": "2022-12-07T02:02:48.253Z",
"lastModifiedAt": "2022-12-07T02:02:48.253Z"
}
}
}

Delete an application by domain for the requesting user.

Authorizations:

bearer_token

path Parameters

domain

required

string

The domain of the application to delete.

Responses

Response samples

200
401
404

Content type

application/json

{"value": {"success": true,
"status": 200,
"data": {"message": "1t8l8s5h01i"
}
}
}

Create a new data entry for an application for the requesting user.

Create a new data entry for an application for the requesting user. The shape of the request body will depend on the schema that was used to create the application.

Authorizations:

bearer_token

path Parameters

domain

required

string

The domain of the application to upload the data to.

Request Body schema: application/json

Request body for ApplicationDataRequestSchema.

example

required

string

Responses

Request samples

Payload

Content type

application/json

{"example": "string"
}

Response samples

201
400
401
404

Content type

application/json

{"value": {"success": true,
"status": 200,
"data": {"domain": "7ux91wcj23x",
"payload": {"example": "7fzfioh1c28"
}
}
}
}

Get data entries for an application for the requesting user.

Get paginated data entries for an application for the requesting user in descending order by creation date.

Authorizations:

bearer_token

path Parameters

domain

required

string

The domain of the application to upload the data to.

query Parameters

start	number The index cursor where to start the list of data entries. Defaults to `0`.
limit	number The number of data entries to return. Defaults to `50`.

Responses

Response samples

200
400
401
404

Content type

application/json

{"value": {"success": true,
"status": 200,
"data": {"result": [{"domain": "z7os6azs7x",
"payload": {"example": "r9uwaak3tji"
},
"createdAt": "2022-12-07T02:02:48.300Z"
}
],
"pagination": {"limit": 1,
"current": 4,
"previous": 2,
"next": 2,
"total": 4,
"isLast": false
}
}
}
}

Export all data entries for an application for the requesting user as CSV.

Authorizations:

bearer_token

path Parameters

domain

required

string

The domain of the application to upload the data to.

Responses

Response samples

401
404

Content type

application/json

{"success": false,
"status": 401,
"error": {"name": "UnauthorizedRequestError",
"description": "Please check that you have passed the correct bearer token inside the Authentication header.",
"message": "A bearer token is required to access this endpoint."
}
}