Auth
api/auth/login
Example response:
{
"data": {
"message": "You have logged in successfully",
"status_code": 200
}
}HTTP Request
POST api/auth/login
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| string | required | |||
| password | string | required |
api/auth/logout
Example response:
{
"data": {
"message": "You have logged out successfully",
"status_code": 200
}
}HTTP Request
POST api/auth/logout
api/auth/create-testing-token
Example response:
{
"data": {
"access_token": "sSM1zRxzfpfIvBRe9d1XzfETZlwvGyDXqK94BOhi8eTc3sXF34JU7qKVVGemwzv8ZcnsNbOLzLFnXYZ",
"status_code": 200
}
}HTTP Request
POST api/auth/create-testing-token
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| string | required | |||
| password | string | required |
api/auth/forgot-password
Example response:
{
}HTTP Request
POST api/auth/forgot-password
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| string | required |
api/auth/reset-password
Example response:
{
}HTTP Request
POST api/auth/reset-password
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| token | string | required | ||
| string | required and email | |||
| password | string | required | ||
| password_confirmation | string | required |
api/auth/change-password
Example response:
{
}HTTP Request
POST api/auth/change-password
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| old_password | string | required | ||
| new_password | string | required | ||
| new_password_confirmation | string | required |
Errors
B5-Spark uses conventional HTTP response codes to indicate the success or failure of an API request. The table below contains a summary of the typical response codes
| Code | Description |
|---|---|
| 200 | Everything is ok. |
| 400 | Valid data was given but the request has failed. |
| 401 | No valid API Key was given. |
| 404 | The request resource could not be found. |
| 419 | Invalid token or session expired. |
| 422 | The payload has missing required parameters or invalid data was given. |
| 429 | Too many attempts. |
| 500 | Request failed due to an internal error . |
| 503 | Server is offline for maintenance |
Clients
Clients Datatable
Example (DataTables) response:
{
"draw": 0,
"recordsTotal": 2,
"recordsFiltered": 2,
"data": [
{
"id": 2,
"name": "client",
"email": "client@tcm.com",
"profile_picture_path": null,
"created_at": "03-02-2021 06:48:03",
"updated_at": "03-02-2021 06:48:03",
"last_active_at": null,
"role": {
"id": 2,
"name": "client",
"title": "Client",
"guard_name": "web",
"created_at": "2021-02-03T06:48:03.000000Z",
"updated_at": "2021-02-03T06:48:03.000000Z",
"pivot": {
"model_id": 2,
"role_id": 2,
"model_type": "App\\Models\\User\\User"
}
}
},
{
"id": 3,
"name": "Miryam",
"email": "client1@gmail.com",
"profile_picture_path": "http://127.0.0.1:8000/images/users/profile_pictures/Screenshot from 2021-02-02 12-54-32-Zsrcfoo7Q0.png",
"created_at": "03-02-2021 10:27:49",
"updated_at": "03-02-2021 14:55:11",
"last_active_at": null,
"client_detail": {
"id": 1,
"user_id": 3,
"surname": "Maher",
"company_name": "bobo",
"position": null,
"country": null,
"linkedin_profile_url": "https://www.linkedin.com/login",
"facebook_profile_url": null,
"twitter_handle_url": null,
"instagram_profile_url": null,
"company_career_page_url": "https://www.facebook.com/ams.holdings.37",
"company_website_url": null,
"company_description": null,
"created_at": "03-02-2021 10:27:49",
"updated_at": "03-02-2021 15:19:06"
},
"role": {
"id": 2,
"name": "client",
"title": "Client",
"guard_name": "web",
"created_at": "2021-02-03T06:48:03.000000Z",
"updated_at": "2021-02-03T06:48:03.000000Z",
"pivot": {
"model_id": 3,
"role_id": 2,
"model_type": "App\\Models\\User\\User"
}
}
}
],
"queries": [
{
"query": "select count(*) as aggregate from (select '1' as `row_count` from `users` where exists (select * from `roles` inner join `model_has_roles` on `roles`.`id` = `model_has_roles`.`role_id` where `users`.`id` = `model_has_roles`.`model_id` and `model_has_roles`.`model_type` = ? and `name` = ?)) count_row_table",
"bindings": [
"App\\Models\\User\\User",
"client"
],
"time": "0.74"
},
{
"query": "select * from `users` where exists (select * from `roles` inner join `model_has_roles` on `roles`.`id` = `model_has_roles`.`role_id` where `users`.`id` = `model_has_roles`.`model_id` and `model_has_roles`.`model_type` = ? and `name` = ?)",
"bindings": [
"App\\Models\\User\\User",
"client"
],
"time": "0.57"
},
{
"query": "select * from `client_details` where `client_details`.`user_id` in (2, 3)",
"bindings": [],
"time": "0.51"
},
{
"query": "select `roles`.*, `model_has_roles`.`model_id` as `pivot_model_id`, `model_has_roles`.`role_id` as `pivot_role_id`, `model_has_roles`.`model_type` as `pivot_model_type` from `roles` inner join `model_has_roles` on `roles`.`id` = `model_has_roles`.`role_id` where `model_has_roles`.`model_id` = ? and `model_has_roles`.`model_type` = ?",
"bindings": [
"2",
"App\\Models\\User\\User"
],
"time": "0.61"
},
{
"query": "select `roles`.*, `model_has_roles`.`model_id` as `pivot_model_id`, `model_has_roles`.`role_id` as `pivot_role_id`, `model_has_roles`.`model_type` as `pivot_model_type` from `roles` inner join `model_has_roles` on `roles`.`id` = `model_has_roles`.`role_id` where `model_has_roles`.`model_id` = ? and `model_has_roles`.`model_type` = ?",
"bindings": [
"3",
"App\\Models\\User\\User"
],
"time": "0.51"
}
],
"input": {
"role": "client"
}
}HTTP Request
GET api/users?role=client can filter using ?is_active=
Create Client
Example response:
HTTP Request
POST api/users
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| name | string | required | ||
| string | required and email | |||
| password | string | required | confirmed | |
| profile_picture | file | optional | jpeg,jpg,bmp,png,gif | |
| role | string | required | exists:roles,name 'client' | |
| surname | string | required | ||
| company_name | string | required | ||
| position | string | sometimes | ||
| country | string | sometimes | ||
| linkedin_profile_url | url | sometimes | ||
| facebook_profile_url | url | sometimes | ||
| twitter_handle_url | url | sometimes | ||
| instagram_profile_url | url | sometimes | ||
| company_career_page_url | url | sometimes | ||
| company_website_url | url | sometimes | ||
| company_description | text | sometimes | ||
| campaign_limit | integer | required |
Update Client
Example response:
HTTP Request
PUT api/users/{id}
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| name | string | required | ||
| string | required and email | |||
| profile_picture | file | optional | jpeg,jpg,bmp,png,gif | |
| role | string | required | exists:roles,name 'client' | |
| surname | string | required | ||
| company_name | string | required | ||
| position | string | sometimes | ||
| country | string | sometimes | ||
| linkedin_profile_url | url | sometimes | ||
| facebook_profile_url | url | sometimes | ||
| twitter_handle_url | url | sometimes | ||
| instagram_profile_url | url | sometimes | ||
| company_career_page_url | url | sometimes | ||
| company_website_url | url | sometimes | ||
| company_description | text | sometimes | ||
| campaign_limit | integer | required | ||
| analytics | array | sometimes | (id: analytic_id, value:url) |
Client Details
Example response:
{
"data": {
"id": 3,
"name": "Miryam",
"email": "client1@gmail.com",
"profile_picture_path": "http://127.0.0.1:8000/images/users/profile_pictures/Screenshot from 2021-02-02 12-54-32-Zsrcfoo7Q0.png",
"created_at": "03-02-2021 10:27:49",
"updated_at": "03-02-2021 14:55:11",
"last_active_at": null,
"role": {
"id": 2,
"name": "client",
"title": "Client",
"guard_name": "web",
"created_at": "2021-02-03T06:48:03.000000Z",
"updated_at": "2021-02-03T06:48:03.000000Z",
"pivot": {
"model_id": 3,
"role_id": 2,
"model_type": "App\\Models\\User\\User"
}
},
"client_detail": {
"id": 1,
"user_id": 3,
"surname": "Maher",
"company_name": "bobo",
"position": null,
"country": null,
"linkedin_profile_url": "https://www.linkedin.com/login",
"facebook_profile_url": null,
"twitter_handle_url": null,
"instagram_profile_url": null,
"company_career_page_url": "https://www.facebook.com/ams.holdings.37",
"company_website_url": null,
"company_description": null,
"is_active": 1,
"created_at": "03-02-2021 10:27:49",
"updated_at": "03-02-2021 15:19:06"
}
}
}HTTP Request
GET api/users/{id}
Change Status
Example response:
{
"data": {
"message": "Client Status changed successfully",
"data": null,
"status_code": 200
}
}HTTP Request
GET api/users/{id}/change-status
Logged in Client profile
Example response:
{
"data": {
"id": 3,
"name": "Miryam",
"email": "client1@gmail.com",
"profile_picture_path": null,
"created_at": "03-02-2021 10:27:49",
"updated_at": "03-02-2021 11:49:31",
"last_active_at": null,
"role": {
"id": 2,
"name": "client",
"title": "Client",
"guard_name": "web",
"created_at": "2021-02-03T06:48:03.000000Z",
"updated_at": "2021-02-03T06:48:03.000000Z",
"pivot": {
"model_id": 3,
"role_id": 2,
"model_type": "App\\Models\\User\\User"
}
},
"client_detail": {
"id": 1,
"user_id": 3,
"surname": "Mamdouh",
"company_name": "B5 Digital",
"position": null,
"country": null,
"linkedin_profile_url": "https://www.linkedin.com/login",
"facebook_profile_url": null,
"twitter_handle_url": null,
"instagram_profile_url": null,
"company_career_page_url": "https://www.facebook.com/ams.holdings.37",
"company_website_url": null,
"company_description": null,
"created_at": "03-02-2021 10:27:49",
"updated_at": "03-02-2021 10:27:49"
}
}
}HTTP Request
GET api/users/me
Update Logged in Client Profile
Example response:
{
"data": {
"message": "User updated successfully",
"data": {
"id": 3,
"name": "Miryam",
"email": "client1@gmail.com",
"profile_picture_path": null,
"created_at": "03-02-2021 10:27:49",
"updated_at": "03-02-2021 11:49:31",
"last_active_at": null,
"role": {
"id": 2,
"name": "client",
"title": "Client",
"guard_name": "web",
"created_at": "2021-02-03T06:48:03.000000Z",
"updated_at": "2021-02-03T06:48:03.000000Z",
"pivot": {
"model_id": 3,
"role_id": 2,
"model_type": "App\\Models\\User\\User"
}
},
"client_detail": {
"id": 1,
"user_id": 3,
"surname": "Mamdouh",
"company_name": "B5 Digital",
"position": null,
"country": null,
"linkedin_profile_url": "https://www.linkedin.com/login",
"facebook_profile_url": null,
"twitter_handle_url": null,
"instagram_profile_url": null,
"company_career_page_url": "https://www.facebook.com/ams.holdings.37",
"company_website_url": null,
"company_description": null,
"created_at": "03-02-2021 10:27:49",
"updated_at": "03-02-2021 10:27:49"
}
},
"status_code": 200
}
}HTTP Request
PUT api/users/me
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| name | string | required | ||
| string | required and email | |||
| profile_picture | file | optional | jpeg,jpg,bmp,png,gif | |
| surname | string | required | ||
| company_name | string | required | ||
| position | string | sometimes | ||
| country | string | sometimes | ||
| linkedin_profile_url | url | sometimes | ||
| facebook_profile_url | url | sometimes | ||
| twitter_handle_url | url | sometimes | ||
| instagram_profile_url | url | sometimes | ||
| company_career_page_url | url | sometimes | ||
| company_website_url | url | sometimes | ||
| company_description | text | sometimes |
Removed Logged in Client ProfilePicture
Example response:
{
"data": {
"message": "Picture was removed successfully",
"status_code": 200
}
}HTTP Request
PUT api/users/me/removeProfilePicture
Users
Users Datatable
Example (DataTables) response:
{
"draw": 0,
"recordsTotal": 2,
"recordsFiltered": 2,
"data": [
{
"id": 1,
"name": "admin",
"email": "admin@b5-spark.com",
"profile_picture_path": null,
"created_at": "03-02-2021 06:48:03",
"updated_at": "03-02-2021 11:32:56",
"last_active_at": null,
"role": {
"id": 1,
"name": "user",
"title": "User",
"guard_name": "web",
"created_at": "2021-02-03T06:48:03.000000Z",
"updated_at": "2021-02-03T06:48:03.000000Z",
"pivot": {
"model_id": 1,
"role_id": 1,
"model_type": "App\\Models\\User\\User"
}
}
},
{
"id": 4,
"name": "ahmed nouh Osman",
"email": "user1@gmail.com",
"profile_picture_path": "http://127.0.0.1:8000/images/users/profile_pictures/Screenshot from 2021-02-02 12-54-32-Rb14SlqmpF.png",
"created_at": "03-02-2021 10:38:52",
"updated_at": "03-02-2021 15:25:47",
"last_active_at": null,
"role": {
"id": 1,
"name": "user",
"title": "User",
"guard_name": "web",
"created_at": "2021-02-03T06:48:03.000000Z",
"updated_at": "2021-02-03T06:48:03.000000Z",
"pivot": {
"model_id": 4,
"role_id": 1,
"model_type": "App\\Models\\User\\User"
}
}
}
],
"queries": [
{
"query": "select count(*) as aggregate from (select '1' as `row_count` from `users` where exists (select * from `roles` inner join `model_has_roles` on `roles`.`id` = `model_has_roles`.`role_id` where `users`.`id` = `model_has_roles`.`model_id` and `model_has_roles`.`model_type` = ? and `name` = ?)) count_row_table",
"bindings": [
"App\\Models\\User\\User",
"user"
],
"time": "3.18"
},
{
"query": "select * from `users` where exists (select * from `roles` inner join `model_has_roles` on `roles`.`id` = `model_has_roles`.`role_id` where `users`.`id` = `model_has_roles`.`model_id` and `model_has_roles`.`model_type` = ? and `name` = ?)",
"bindings": [
"App\\Models\\User\\User",
"user"
],
"time": "0.55"
},
{
"query": "select `roles`.*, `model_has_roles`.`model_id` as `pivot_model_id`, `model_has_roles`.`role_id` as `pivot_role_id`, `model_has_roles`.`model_type` as `pivot_model_type` from `roles` inner join `model_has_roles` on `roles`.`id` = `model_has_roles`.`role_id` where `model_has_roles`.`model_id` = ? and `model_has_roles`.`model_type` = ?",
"bindings": [
"1",
"App\\Models\\User\\User"
],
"time": "0.55"
},
{
"query": "select * from `client_details` where `client_details`.`user_id` = ? and `client_details`.`user_id` is not null limit 1",
"bindings": [
"1"
],
"time": "0.44"
},
{
"query": "select `roles`.*, `model_has_roles`.`model_id` as `pivot_model_id`, `model_has_roles`.`role_id` as `pivot_role_id`, `model_has_roles`.`model_type` as `pivot_model_type` from `roles` inner join `model_has_roles` on `roles`.`id` = `model_has_roles`.`role_id` where `model_has_roles`.`model_id` = ? and `model_has_roles`.`model_type` = ?",
"bindings": [
"4",
"App\\Models\\User\\User"
],
"time": "0.66"
},
{
"query": "select * from `client_details` where `client_details`.`user_id` = ? and `client_details`.`user_id` is not null limit 1",
"bindings": [
"4"
],
"time": "0.57"
}
],
"input": {
"role": "user"
}
}HTTP Request
GET api/users?role=user
Create User
Example response:
{
"data": {
"message": "User have created successfully",
"data": null,
"status_code": 200
}
}HTTP Request
POST api/users
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| name | string | required | ||
| string | required and email | |||
| password | string | required | ||
| password_confirmation | string | required | ||
| profile_picture | file | optional | jpeg,jpg,bmp,png,gif | |
| role | string | required | exists:roles,name 'user' |
Update User
Example response:
{
"data": {
"message": "User updated successfully",
"data": {
"id": 27,
"name": "Miryam Mamdouh",
"email": "hello3@b5digital.dk",
"profile_picture_path": "http://b5spark.localhost:8000/images/users/profile_pictures/usertesting-ZYnZw5jiMb.jpg",
"role": {
"id": 1,
"name": "Super Admin",
"code": "super_admin",
"guard_name": "web",
"created_at": "2020-01-21 18:15:29",
"updated_at": "2020-01-21 18:15:29",
"pivot": {
"model_id": 27,
"role_id": 1,
"model_type": "App\\Models\\User"
}
}
},
"status_code": 200
}
}HTTP Request
PUT api/users/{id}
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| name | string | required | ||
| string | required and email | |||
| profile_picture | file | optional | jpeg,jpg,bmp,png,gif | |
| role | string | required | exists:roles,name 'user' |
User Details
Example response:
{
"data": {
"id": 31,
"name": "admin",
"email": "admin@et-spark.com",
"profile_picture_path": null,
"role": {
"id": 1,
"name": "Super Admin",
"code": "super_admin",
"guard_name": "web",
"created_at": "2020-01-21 18:15:29",
"updated_at": "2020-01-21 18:15:29",
"pivot": {
"model_id": 31,
"role_id": 1,
"model_type": "App\\Models\\User"
}
}
}
}HTTP Request
GET api/users/{id}
Delete User
Example response:
{
"data": {
"message": "User deleted successfully",
"data": null,
"status_code": 200
}
}HTTP Request
DELETE api/users/{id}
Logged in User profile
Example response:
{
"data": {
"id": 4,
"name": "ahmed nouh",
"email": "user1@gmail.com",
"profile_picture_path": "http://127.0.0.1:8000/images/users/profile_pictures/Screenshot from 2021-02-02 12-54-32-coEeiaO6MT.png",
"created_at": "03-02-2021 10:38:52",
"updated_at": "03-02-2021 12:37:31",
"last_active_at": null,
"role": {
"id": 1,
"name": "user",
"title": "User",
"guard_name": "web",
"created_at": "2021-02-03T06:48:03.000000Z",
"updated_at": "2021-02-03T06:48:03.000000Z",
"pivot": {
"model_id": 4,
"role_id": 1,
"model_type": "App\\Models\\User\\User"
}
}
}
}HTTP Request
GET api/users/me
Update Logged in User Profile
Example response:
{
"data": {
"message": "User updated successfully",
"data": {
"id": 27,
"name": "Miryam Mamdouh",
"email": "hello3@b5digital.dk",
"profile_picture_path": "http://b5spark.localhost:8000/images/users/profile_pictures/usertesting-ZYnZw5jiMb.jpg",
"role": {
"id": 1,
"name": "Super Admin",
"code": "super_admin",
"guard_name": "web",
"created_at": "2020-01-21 18:15:29",
"updated_at": "2020-01-21 18:15:29",
"pivot": {
"model_id": 27,
"role_id": 1,
"model_type": "App\\Models\\User"
}
}
},
"status_code": 200
}
}HTTP Request
PUT api/users/me
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| name | string | required | ||
| string | required and email |
Removed Logged in User ProfilePicture
Example response:
{
"data": {
"message": "Picture was removed successfully",
"status_code": 200
}
}HTTP Request
PUT api/users/me/removeProfilePicture
Setting
Get all settings
Example response:
{
"data": [
{
"id": 5,
"code": "test_analysis",
"key": "test analysis",
"value": "1",
"category_id": 7,
"created_at": "05-10-2021 15:01:43",
"updated_at": "05-10-2021 15:01:43",
"type_id": {
"id": 7,
"code": "analytics_types",
"name": "Analytics Types",
"created_at": "25-05-2021 16:02:25",
"updated_at": "25-05-2021 16:02:25"
}
},
{
"id": 6,
"code": "test_analysis",
"key": "test analysis",
"value": "1",
"category_id": 7,
"created_at": "05-10-2021 15:01:44",
"updated_at": "05-10-2021 15:01:44",
"type_id": {
"id": 7,
"code": "analytics_types",
"name": "Analytics Types",
"created_at": "25-05-2021 16:02:25",
"updated_at": "25-05-2021 16:02:25"
}
}
]
}HTTP Request
GET api/settings
Store setting
Example response:
{
"data": {
"message": "messages.SystemSetting have created successfully",
"data": {
"key": "test analysis",
"value": "1",
"category_id": 1,
"code": "test_analysis",
"updated_at": "06-10-2021 11:11:55",
"created_at": "06-10-2021 11:11:55",
"id": 7,
"type_id": {
"id": 1,
"code": "goals",
"name": "Goals",
"created_at": "04-03-2021 11:03:56",
"updated_at": "04-03-2021 11:03:56"
}
}
}
}HTTP Request
POST api/settings
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| key | string | required | unique ,alpha_dash | |
| value | string | required | ||
| category_id | integer | required |
Update Setting
Example response:
{
"data": {
"message": "SystemSetting updated successfully",
"data": {
"id": 7,
"code": "test_analysis",
"key": "test analysis",
"value": "1",
"category_id": 1,
"created_at": "06-10-2021 11:11:55",
"updated_at": "06-10-2021 11:11:55",
"type_id": {
"id": 1,
"code": "goals",
"name": "Goals",
"created_at": "04-03-2021 11:03:56",
"updated_at": "04-03-2021 11:03:56"
}
},
"status_code": 200
}
}HTTP Request
PUT api/settings/{id}
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| key | string | required | unique ,alpha_dash | |
| value | string | required | ||
| category_id | integer | required |
Get Setting Details
Example response:
{
"data": {
"id": 7,
"code": "test_analysis",
"key": "test analysis",
"value": "1",
"category_id": 1,
"created_at": "06-10-2021 11:11:55",
"updated_at": "06-10-2021 11:11:55",
"type_id": {
"id": 1,
"code": "goals",
"name": "Goals",
"created_at": "04-03-2021 11:03:56",
"updated_at": "04-03-2021 11:03:56"
}
}
}HTTP Request
GET api/settings/{id}
Roles
Get All Roles
Example response:
{
"data": [
{
"id": 1,
"name": "Super Admin",
"code": "super_admin",
"guard_name": "web",
"created_at": "2020-01-21 18:15:29",
"updated_at": "2020-01-21 18:15:29"
}
]
}HTTP Request
GET api/roles
Lookups
Get All Lookup Categories
Example response:
{
"data": [
{
"id": 1,
"code": "customer_types",
"name": "Customer Types",
"created_at": "20-05-2020 08:32:30",
"updated_at": "20-05-2020 08:32:30"
},
{
"id": 2,
"code": "contract_statuses",
"name": "Contract Statuses",
"created_at": "20-05-2020 08:32:30",
"updated_at": "20-05-2020 08:32:30"
}
]
}HTTP Request
GET api/lookups/categories
Get All Lookups
Example response:
{
"data": [
{
"id": 2,
"code": "corporate",
"name": "Corporate",
"value": "2",
"extra_details": null,
"model_type": "App\\Models\\Customer\\Customer",
"category_id": 2,
"is_active": 1,
"is_system": 0,
"created_at": "20-05-2020 08:33:11",
"updated_at": "20-05-2020 08:33:11"
}
]
}HTTP Request
GET api/lookups/getAll
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| search | string | optional | ||
| category_id | integer | optional | ||
| category_code | string | optional |
Add New Lookup
Example response:
{
"data": {
"message": "Lookup have created successfully",
"data": null,
"status_code": 200
}
}HTTP Request
POST api/lookups
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| name | string | required | max 100, unique | |
| category_id | integer | required | ||
| value | string | required | max 100 |
Update Lookup
Example response:
{
"data": {
"message": "Lookup updated successfully",
"data": {
"id": 3,
"code": "testing_add",
"name": "testing",
"value": "5",
"extra_details": null,
"model_type": "App\\Models\\Customer\\Customer",
"category_id": "1",
"is_active": 1,
"is_system": 0,
"created_at": "20-05-2020 09:50:19",
"updated_at": "20-05-2020 09:52:26"
},
"status_code": 200
}
}HTTP Request
PUT api/lookups/3
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| name | string | required | max 100, unique | |
| category_id | integer | required |
Get Lookup details
Example response:
{
"data": {
"id": 3,
"code": "testing_add",
"name": "testing",
"value": "5",
"extra_details": null,
"model_type": "App\\Models\\Customer\\Customer",
"category_id": 1,
"is_active": 1,
"is_system": 0,
"created_at": "20-05-2020 09:50:19",
"updated_at": "20-05-2020 09:52:26"
}
}HTTP Request
GET api/lookups/3
Get Lookup Datatable
Example response:
{
"draw": 0,
"recordsTotal": 1,
"recordsFiltered": 1,
"data": [
{
"id": "2",
"code": "corporate",
"name": "Corporate",
"value": "2",
"extra_details": null,
"model_type": "App\\Models\\Customer\\Customer",
"category_id": "2",
"is_active": "1",
"is_system": 0,
"created_at": "20-05-2020 08:33:11",
"updated_at": "20-05-2020 08:33:11",
"category": {
"id": "2",
"code": "contract_statuses",
"name": "Contract Statuses",
"created_at": "20-05-2020 08:32:30",
"updated_at": "20-05-2020 08:32:30"
}
}
],
"queries": [
{
"query": "select count(*) as aggregate from (select '1' as `row_count` from `lookups` where `category_id` = ? and `is_system` = ?) count_row_table",
"bindings": [
"2",
""
],
"time": "10.68"
},
{
"query": "select * from `lookups` where `category_id` = ? and `is_system` = ?",
"bindings": [
"2",
""
],
"time": "0.35"
},
{
"query": "select * from `lookup_categories` where `lookup_categories`.`id` in (2)",
"bindings": [],
"time": "0.48"
}
],
"input": {
"category_id": "2"
}
}HTTP Request
GET api/lookups/getAll/datatable
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| category_id | integer | optional |
Countries
List Countries
Example response:
{
"data": [
"Australia",
"Mali",
"Somalia"
]
}HTTP Request
GET api/countries can filter using ?q=
Client Media
List Client Media
Example response:
{
"data": {
"current_page": 1,
"data": {
"2": "https://tcm-develop.s3.eu-central-1.amazonaws.com/2/-TP-3-Clients-Management-Jira-%281%29.jpg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQGSJHROG25ZAGGNQ%2F20210215%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210215T214014Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=f137035a3a11b88e5eb3744642587f519cd0b7545422ca1cbf02ff9fece2712b",
"3": "https://tcm-develop.s3.eu-central-1.amazonaws.com/3/-TP-3-Clients-Management-Jira-%281%29.jpg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQGSJHROG25ZAGGNQ%2F20210215%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210215T214014Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=53728cdc99b9614563af27a17dcb70a0cdd6cbe04cc59e740f0078100c4a0ddb",
"4": "https://tcm-develop.s3.eu-central-1.amazonaws.com/4/-TP-3-Clients-Management-Jira-%281%29.jpg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQGSJHROG25ZAGGNQ%2F20210215%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210215T214014Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=8e19d1ae3d7eb933ef9d47a8ebb439e7e7354da7e8218de249fe7c49c918ec3b",
"5": "https://tcm-develop.s3.eu-central-1.amazonaws.com/5/-TP-3-Clients-Management-Jira-%281%29.jpg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQGSJHROG25ZAGGNQ%2F20210215%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210215T214014Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=b9faa4ed8a714856d94f87263dff5e874a39d1821fb9c3a8549ac208f207dda8",
"6": "https://tcm-develop.s3.eu-central-1.amazonaws.com/6/-TP-3-Clients-Management-Jira-%281%29.jpg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQGSJHROG25ZAGGNQ%2F20210215%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210215T214014Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=5416c54f675b667a823c1839c2d7439a862e0198504bfd0e8b33366646d0d719",
"7": "https://tcm-develop.s3.eu-central-1.amazonaws.com/7/-TP-3-Clients-Management-Jira.jpg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQGSJHROG25ZAGGNQ%2F20210215%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210215T214014Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=e857b30b51dc2da051475aef2e6724fa9a473afd1bd0bb85bd308dc46436ed6f"
},
"first_page_url": "http://tcmportal.localhost:8000/api/client/media/getAll?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://tcmportal.localhost:8000/api/client/media/getAll?page=1",
"next_page_url": null,
"path": "http://tcmportal.localhost:8000/api/client/media/getAll",
"per_page": 18,
"prev_page_url": null,
"to": 6,
"total": 6
}
}HTTP Request
GET api/client/media/getAll
Delete All Media
Delete Client Collection
Example response:
{
"data": {
"message": "All Client media deleted Successfully",
"data": null,
"status_code": 200
}
}HTTP Request
DELETE api/client/media/delete-all
Delete Media
Example response:
{
"data": {
"message": "Media deleted Successfully",
"data": null,
"status_code": 200
}
}HTTP Request
POST api/client/media/delete
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| media_arr | array | required | ||
| media_arr.* | array | int | exists:media,id |
Add Media
Example response:
{
"data": {
"message": "media added Successfully",
"data": null,
"status_code": 200
}
}HTTP Request
POST api/client/media/add
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| media | array | required | ||
| media.* | image | required | mimes:jpeg,jpg,png | dimensions:min_width=600,min_height=600 |
Goals
Get Goals
Example response:
{
"data": [
{
"id": 1,
"code": "reach",
"name": "Reach",
"value": null,
"model_type": "App\\Models\\Goals\\Goal",
"extra_details": null,
"category_id": 1,
"is_active": 1,
"is_system": 1,
"created_at": "28-02-2021 15:25:34",
"updated_at": "28-02-2021 15:25:34"
}
]
}HTTP Request
GET /api/lookups/getAll
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| category_code | string | goals |
Budgets
Get Budgets
Example response:
{
"data": [
{
"id": 1,
"code": "reach_ad",
"name": "Reach ad",
"value": null,
"model_type": "App\\Models\\Budgets\\Budget",
"extra_details": null,
"category_id": 1,
"is_active": 1,
"is_system": 1,
"created_at": "28-02-2021 15:25:34",
"updated_at": "28-02-2021 15:25:34"
}
]
}HTTP Request
GET /api/lookups/getAll
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| category_code | string | budgets |
Placements
Get Placements
Example response:
{
"data": [
{
"id": 11,
"code": "automatic_by_default",
"name": "Automatic by default",
"value": null,
"model_type": "App\\Models\\Placements\\Placement",
"extra_details": null,
"category_id": 4,
"is_active": 1,
"is_system": 1,
"created_at": "28-02-2021 17:13:22",
"updated_at": "28-02-2021 17:13:22"
}
]
}HTTP Request
GET /api/lookups/getAll
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| category_code | string | placements |
AdTypes
Get adTypes
Example response:
{
"data": [
{
"id": 9,
"code": "single_image",
"name": "Single image",
"value": null,
"model_type": "App\\Models\\AdTypes\\AdType",
"extra_details": null,
"category_id": 3,
"is_active": 1,
"is_system": 1,
"created_at": "28-02-2021 15:40:49",
"updated_at": "28-02-2021 15:40:49"
}
]
}HTTP Request
GET /api/lookups/getAll
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| category_code | string | ad_types |
Call to actions
Get Call to actions
Example response:
{
"data": [
{
"id": 13,
"code": "learn_more",
"name": "Learn More",
"value": null,
"model_type": "App\\Models\\CallToActions\\CallToAction",
"extra_details": null,
"category_id": 5,
"is_active": 1,
"is_system": 1,
"created_at": "04-03-2021 13:40:05",
"updated_at": "04-03-2021 13:40:05"
}
]
}HTTP Request
GET /api/lookups/getAll
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| category_code | string | call_to_actions |
Audience
Get Audience Languages
Example response:
{
"data": [
{
"name": "English (US)",
"key": 6
}
]
}HTTP Request
GET /api/audience/languages
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| q | string | required | en |
Get Audience Demographics
Example response:
{
"data": [
{
"id": "105930651606",
"name": "Harvard University",
"type": "education_schools",
"path": [
"Demographics",
"Education",
"Schools/Universities",
"Harvard University"
],
"audience_size": 18917163
}
]
}HTTP Request
GET /api/audience/demographics
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| q | string | required | harvard | |
| countries | array | required | array of country codes | |
| regulated_categories | array | required | array of special categories codes EX: ['EMPLOYMENT'] | |
| exclude_types | array | nullable | ['work_positions','work_employers'] |
Get Filters Keywords
Example response:
{
"data": {
"locations": [
"United States",
"United Kingdom",
"Canada",
"Germany",
"Netherlands",
"Australia"
],
"titles": [
"Director",
"Engineer",
"Executive",
"Manager",
"Sales"
],
"skills": [
"Microsoft Excel",
"Project Coordination",
"Program Management",
"Technical Writing",
"Communication"
],
"employers": [
"Google",
"Apple",
"Microsoft",
"The Coca-Cola Company",
"Walt Disney Company"
],
"fieldsOfStudy": [
"Economics",
"Social",
"Computer Science",
"Marketing",
"Business"
]
}
}HTTP Request
GET /api/linkedin/keywords
Get Audience Locations
Example response:
{
"data": [
{
"key": "BA",
"name": "Bosnia & Herzegovina",
"type": "country",
"country_code": "BA",
"country_name": "Bosnia and Herzegovina",
"supports_region": false,
"supports_city": true,
"can_edit_gender_and_age": true
}
]
}HTTP Request
GET /api/audience/locations
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| q | string | required | un | |
| types | array | nullable | ['country','city'] |
Get Audience Suggestions
Example response:
{
"data": [
{
"id": "6003348604581",
"name": "Fashion accessories",
"type": "interests",
"path": [
"Interests",
"Shopping and fashion",
"Fashion accessories"
],
"audience_size": 577987610
}
]
}HTTP Request
POST /api/audience/Suggestions
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| targeting_list | array | required | (array has ids and types) | |
| targeting_list[type] | string | required | interests | |
| targeting_list[id] | string | required | 6003119440445 |
Store Audience
Example response:
{
"data": {
"message": [
"audience_created_successfully"
]
}
}HTTP Request
POST /api/audience
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| name | string | nullable | ||
| age_from | integer | required | min 13 | |
| age_to | integer | required | ||
| gender | integer | required | all:0, male:1, female:2 | |
| locations | array | required | name, type, country_code, country_name | |
| demographics | array | required | interests object has (name, type, path in array) | |
| languages | array | required | name |
Update Audience
Example response:
{
"data": {
"message": [
"audience_updated_successfully"
],
"data": null,
"status_code": 200
}
}HTTP Request
PUT /api/audience/{id}
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| name | string | nullable | ||
| age_from | integer | required | min 13 | |
| age_to | integer | required | ||
| gender | integer | required | all:0, male:1, female:2 | |
| locations | array | required | (id if update exists location) & name & type & country_code & country_name | |
| demographics | array | required | if update exists demographic (id and not in interests object) & interests object has (name & type & path in array) | |
| languages | array | required | (id if update exists language) & name |
List Audience
Example response:
{
"data": {
"id": 1,
"name": "Ali",
"age_from": "13",
"age_to": "100",
"gender": "2",
"created_at": "13-03-2021 22:04:33",
"updated_at": "13-03-2021 22:04:33",
"locations": [
{
"id": 1,
"audience_id": 1,
"name": "Egypt",
"type": "country",
"country_code": "EG",
"country_name": "Egypt",
"region": null,
"region_id": null,
"created_at": "13-03-2021 22:04:33",
"updated_at": "13-03-2021 22:04:33"
},
],
"demographics": [
{
"id": 1,
"audience_id": 1,
"name": "Hip hop music",
"type": "test",
"path": "\"test\"",
"created_at": "13-03-2021 22:04:33",
"updated_at": "13-03-2021 22:04:33"
},
],
"languages": [
{
"id": 1,
"audience_id": 1,
"name": "English (US)",
"created_at": "13-03-2021 22:04:33",
"updated_at": "13-03-2021 22:04:33"
}
]
}
}HTTP Request
GET /api/audience/data/{ListOrDatatable}
Parameters
| Parameter | Type | Status | Description |
|---|
Show Audience
Example response:
{
"data": {
"id": 1,
"name": "Ali",
"age_from": "13",
"age_to": "100",
"gender": "2",
"created_at": "13-03-2021 22:04:33",
"updated_at": "13-03-2021 22:04:33",
"locations": [
{
"id": 1,
"audience_id": 1,
"name": "Egypt",
"type": "country",
"country_code": "EG",
"country_name": "Egypt",
"region": null,
"region_id": null,
"created_at": "13-03-2021 22:04:33",
"updated_at": "13-03-2021 22:04:33"
},
],
"demographics": [
{
"id": 1,
"audience_id": 1,
"name": "Hip hop music",
"type": "test",
"path": "\"test\"",
"created_at": "13-03-2021 22:04:33",
"updated_at": "13-03-2021 22:04:33"
},
],
"languages": [
{
"id": 1,
"audience_id": 1,
"name": "English (US)",
"created_at": "13-03-2021 22:04:33",
"updated_at": "13-03-2021 22:04:33"
}
]
}
}HTTP Request
GET /api/audience/{id}
Parameters
| Parameter | Type | Status | Description |
|---|
Delete Audience
Example response:
{
"data": {
"message": "Audience deleted successfully",
"data": null,
"status_code": 200
}
}HTTP Request
DELETE /api/audience/{id}
Parameters
| Parameter | Type | Status | Description |
|---|
Campaign
Store Campaign
Example response:
{
"data": {
"message": [
"campaign_created_successfully"
]
}
}HTTP Request
POST /api/campaign
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| name | string | nullable | ||
| title | string | required | ||
| goal_id | integer | required | ||
| budget_id | integer | required | ||
| placement_id | integer | required | ||
| ad_type_id | integer | required | ||
| start_date | date | required | ||
| end_date | date | required | ||
| audience | array | name, age_from, age_to, gender , save_this_audience bool, | ||
| audience.locations | array | required | name, type, country_code, country_name | |
| audience.demographics | array | required | interests array [id,name, type, path] | |
| audience.languages | array | required | id, name | |
| ad | array | required | call_to_action, format | |
| ad.single_image | required if format single_image | array | texts array, headlines array, descriptions array, url, image integer | |
| ad.cards | required if format carousel_image | array | link, name, descriptions, image | |
| special_ad_categories | optional | array | EMPLOYMENT |
List Campaigns
Example response:
{
"data": [
{
"id": 1,
"fb_external_id": 23846887190870283,
"title": "the campaign",
"name": "campaign 1",
"goal_id": 6,
"details": null,
"budget_id": 11,
"start_date": "01-03-2021",
"end_date": "10-03-2021",
"audience": {
"name": "Ali",
"age_to": 65,
"gender": 2,
"age_from": 13,
"languages": [
{
"id": 6,
"name": "test"
}
],
"locations": [
{
"name": "Egypt",
"type": "country",
"country_code": "EG",
"country_name": "Egypt"
},
{
"key": "2527622",
"name": "Houston",
"type": "city",
"region": "Texas",
"region_id": 3886,
"country_code": "US",
"country_name": "United States"
}
],
"demographics": [
{
"interests": [
{
"id": "6003225556345",
"name": "Hip hop music",
"path": "test",
"type": "test"
}
]
},
{
"interests": [
{
"id": "6003231864010",
"name": "Photograph",
"path": "test",
"type": "test"
},
{
"id": "6003529635857",
"name": "Photo shoot",
"path": "test",
"type": "test"
}
]
}
],
"save_this_audience": true
},
"created_at": "07-03-2021 21:16:06",
"updated_at": "07-03-2021 21:16:06"
}
]
}HTTP Request
GET /api/campaign/data/{ListOrDatatable}
Parameters
| Parameter | Type | Status | Description |
|---|
Delete Campaign
Example response:
{
"data":{
"message":"Campaign deleted successfully","data":null,"status_code":200
}
}HTTP Request
DELETE /api/campaign/{id}
Parameters
| Parameter | Type | Status | Description |
|---|
Get Preview Campaign
Example response:
{
"data": "<iframe src=\"https://www.facebook.com/ads/api/preview_iframe.php?d=AQLxi0JYWX5rKp3gLhx38CBShwCKSyvnsUMtc5e6Z6w9zIkbkNuu9E4aWlPIi0-jg-Qz_OyJse8BQlxMN4VrZaCKAxJMq37b5WbxBGAC4QWhU4NQ1fZ35trRSpm5rclrBOv_1hi9scOwAeD81ptnfHXE3Uo1GYVkZGaIK8VUwMcOBGLRcojn4wFMRhPZJNgdfL0EY3IA7byOtmrxPdlsbuJ2ou4tfpx5eKIIAGwR6VQ6-bfguepLtf1t7UnNtkPHF1L0xaRs34kzNC--rFOgj_H6d6AjQt4U53heYzwHiKp5Hs0CF2EFCsOzYQecm8pPeEr6HVa62YO2gU9vjuLVoSKXTJsbEM2cTnT-0PfA_XNIfHM0xzb9QJtT3w4KvYAt-Gw&t=AQINM2H_QdHFg77VgeY\" width=\"335\" height=\"450\" scrolling=\"yes\" style=\"border: none;\"></iframe>"
}HTTP Request
GET /api/campaign/preview
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| width | required | |||
| height | required | |||
| ad_format | required | one of the following values [AUDIENCE_NETWORK_INSTREAM_VIDEO, AUDIENCE_NETWORK_INSTREAM_VIDEO_MOBILE, AUDIENCE_NETWORK_OUTSTREAM_VIDEO, AUDIENCE_NETWORK_REWARDED_VIDEO, DESKTOP_FEED_STANDARD, FACEBOOK_STORY_MOBILE, INSTAGRAM_EXPLORE_CONTEXTUAL, INSTAGRAM_EXPLORE_IMMERSIVE, INSTAGRAM_REELS, INSTAGRAM_STANDARD, INSTAGRAM_STORY, INSTANT_ARTICLE_RECIRCULATION_AD, INSTANT_ARTICLE_STANDARD, INSTREAM_BANNER_DESKTOP, INSTREAM_BANNER_MOBILE, INSTREAM_VIDEO_DESKTOP, INSTREAM_VIDEO_IMAGE, INSTREAM_VIDEO_MOBILE, JOB_BROWSER_DESKTOP, JOB_BROWSER_MOBILE, MARKETPLACE_MOBILE, MESSENGER_MOBILE_INBOX_MEDIA, MESSENGER_MOBILE_STORY_MEDIA, MOBILE_BANNER, MOBILE_FEED_BASIC, MOBILE_FEED_STANDARD, MOBILE_FULLWIDTH, MOBILE_INTERSTITIAL, MOBILE_MEDIUM_RECTANGLE, MOBILE_NATIVE, RIGHT_COLUMN_STANDARD, SUGGESTED_VIDEO_DESKTOP, SUGGESTED_VIDEO_MOBILE, WATCH_FEED_HOME, WATCH_FEED_MOBILE] | ||
| ad | array | required | call_to_action, format | |
| ad.single_image | required if format single_image | array | texts array, headlines array, descriptions array, url, image integer | |
| ad.cards | required if format carousel_image | array | link, name, descriptions, image |
Get Reach Campaign
Example response:
{
"data": [
{
"daily_outcomes_curve": [
{
"spend": 0,
"reach": 0,
"impressions": 0,
"actions": 0
}
],
"estimate_dau": 22605766,
"estimate_mau": 24000000,
"estimate_ready": true
}
]
}HTTP Request
GET /api/campaign/reach
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| goal_id | integer | required | ||
| audience | array | name, age_from, age_to, gender , save_this_audience bool, | ||
| audience.locations | array | required | name, type, country_code, country_name | |
| audience.demographics | array | required | interests array [id,name, type, path] | |
| audience.languages | array | required | id, name |
Update Campaign
Example response:
{
"data": {
"message": [
"campaign_updated_successfully"
]
}
}HTTP Request
PUT /api/campaign/{id}
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| name | string | nullable | ||
| title | string | required | ||
| goal_id | integer | required | ||
| budget_id | integer | required | ||
| placement_id | integer | required | ||
| ad_type_id | integer | required | ||
| start_date | date | required | ||
| end_date | date | required | ||
| audience | array | name, age_from, age_to, gender , save_this_audience bool, | ||
| audience.locations | array | required | name, type, country_code, country_name | |
| audience.demographics | array | required | interests array [id,name, type, path] | |
| audience.languages | array | required | id, name | |
| ad | array | required | call_to_action, format | |
| ad.single_image | required if format single_image | array | texts array, headlines array, descriptions array, url, image integer | |
| ad.cards | required if format carousel_image | array | link, name, descriptions, image | |
| special_ad_categories | optional | array | EMPLOYMENT |
Update Campaign Status
Example response:
{
"data": {
"message": [
"campaign_updated_successfully"
]
}
}HTTP Request
PUT /api/campaign/{id}/status
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| status | string | required | ACTIVE, PAUSED, DELETED, ARCHIVED |
Show Campaign
Example response:
{
"data": {
"id": 7,
"fb_external_id": 23846910619980283,
"user_id": 1000,
"title": "the campain",
"name": "campain 1",
"goal_id": 6,
"details": null,
"budget_id": 11,
"start_date": "08-04-2021",
"end_date": "18-04-2021",
"audience": {
"name": "Ali",
"age_to": 65,
"gender": 2,
"age_from": 13,
"languages": [
{
"id": 6,
"name": "test"
},
{
"id": 25,
"name": "test2"
},
{
"id": 17,
"name": "test3"
}
],
"locations": [
{
"name": "Egypt",
"type": "country",
"country_code": "EG",
"country_name": "Egypt"
},
{
"name": "Houston",
"type": "city",
"region": "Texas",
"region_id": 3886,
"country_code": "US",
"country_name": "United States"
}
],
"demographics": [
{
"interests": [
{
"id": "6003225556345",
"name": "Hip hop music",
"path": "test",
"type": "test"
},
{
"id": "6003376894381",
"name": "Rapping",
"path": "test",
"type": "test"
},
{
"id": "6003128658328",
"name": "Underground hip hop",
"path": "test",
"type": "test"
}
]
},
{
"interests": [
{
"id": "6003231864010",
"name": "Photograph",
"path": "test",
"type": "test"
},
{
"id": "6003529635857",
"name": "Photo shoot",
"path": "test",
"type": "test"
}
]
}
],
"save_this_audience": true
},
"created_at": "11-03-2021 09:35:21",
"updated_at": "11-03-2021 09:35:21"
}
}HTTP Request
GET /api/campaign/{id}
Parameters
| Parameter | Type | Status | Description |
|---|
Create Video
Example response:
{
"data": {
"message": "",
"data": "229573865404268",
"status_code": 200
}
}HTTP Request
POST /api/video/create
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| video_id | required | id of video in media |
Status of Video
Example response:
{
"data": {
"message": "",
"data": "ready",
"status_code": 200
}
}HTTP Request
POST /api/video/status
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| fb_hash_id | required | the fb hash id |
List Active Campaigns
Example response:
{
"data": [
{
"id": 305,
"fb_external_id": 23847414187850283,
"user_id": 1000,
"title": "AtodayCampaignTest2",
"name": " AtodayCampaignTest2 - 1000",
"goal_id": 9,
"details": null,
"budget_id": 12,
"start_date": "08-11-2021",
"end_date": "17-12-2021",
"audience": "{\"name\": \"software engineers\", \"age_to\": \"65\", \"gender\": \"0\", \"age_from\": \"18\", \"languages\": [{\"id\": 29, \"name\": \"English (US)\"}], \"locations\": [{\"key\": \"US\", \"name\": \"United States\", \"type\": \"country\", \"country_code\": \"US\", \"country_name\": \"United States\"}], \"demographics\": [{\"interests\": [{\"id\": \"6003371616940\", \"name\": \"Brand\", \"path\": [\"Interests\", \"Additional interests\", \"Brand\"], \"type\": \"interests\", \"grouped\": \"78877\", \"audience_size\": 764618930}, {\"id\": \"6002969730994\", \"name\": \"Calorie\", \"path\": [\"Interests\", \"Additional interests\", \"Calorie\"], \"type\": \"interests\", \"grouped\": \"78877\", \"audience_size\": 118089140}]}], \"save_this_audience\": false}",
"created_at": "08-11-2021 11:12:33",
"updated_at": "08-11-2021 11:12:33"
}
]
}HTTP Request
GET /api/campaign/active/list
Parameters
| Parameter | Type | Status | Description |
|---|
Analysis
Get Market Analysis
Example response:
{
"draw": 0,
"recordsTotal": 1,
"recordsFiltered": 1,
"data": {
"position_type": "new",
"location": "com",
"date": "15-10-2021",
"position_numbers": "100000",
"average_salaries": "999999",
"position_titles": "sdasdasd",
"top_employers": "sdasdasd",
"updated_at": "06-10-2021 11:24:29",
"created_at": "06-10-2021 11:24:29",
"id": 1
}
}HTTP Request
GET /api/market-analysis
Parameters
| Parameter | Type | Status | Description |
|---|
Create Market Analysis
Example response:
{
"data": {
"message": "messages.MarketAnalysis have created successfully",
"data": {
"position_type": "new",
"location": "com",
"date": "15-10-2021",
"position_numbers": "100000",
"average_salaries": "999999",
"position_titles": "sdasdasd",
"top_employers": "sdasdasd",
"updated_at": "06-10-2021 11:24:29",
"created_at": "06-10-2021 11:24:29",
"id": 1
}
}
}HTTP Request
POST /api/market-analysis
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| position_type | required | max:128 | ||
| location | required | max:128 | ||
| position_numbers | nullable | numeric | max:100000 | |
| average_salaries | required | numeric | max: 999999 | |
| position_titles | nullable | max:128 | ||
| top_employers | nullable | max:256 | ||
| date | required | date | date_format:d-m-Y | |
| new_job_statistic | required | bool | ||
| job_statistic | required | string |
Update Market Analysis
Example response:
{
"data": {
"message": "MarketAnalysis updated successfully",
"data": {
"position_type": "new",
"location": "com",
"date": "15-10-2021",
"position_numbers": "100000",
"average_salaries": "999999",
"position_titles": "sdasdasd",
"top_employers": "sdasdasd",
"updated_at": "06-10-2021 11:24:29",
"created_at": "06-10-2021 11:24:29",
"id": 1
},
"status_code": 200
}
}HTTP Request
PUT /api/market-analysis/{id}
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| position_type | required | max:128 | ||
| location | required | max:128 | ||
| position_numbers | nullable | numeric | max:100000 | |
| average_salaries | required | numeric | max: 999999 | |
| position_titles | nullable | max:128 | ||
| top_employers | nullable | max:256 | ||
| date | required | date | date_format:d-m-Y | |
| new_job_statistic | required | bool | ||
| job_statistic | required | string |
DELETE Market Analysis
Example response:
{
"data": {
"message": "MarketAnalysis deleted successfully",
"data": null,
"status_code": 200
}
}HTTP Request
DELETE /api/market-analysis/{id}
Parameters
| Parameter | Type | Status | Description |
|---|
Download Brand Analysis Template
Example response:
{
download file
}HTTP Requestt
GET /api/market-analysis/download-template
Parameters
| Parameter | Type | Status | Description |
|---|
Import Market Analysis Template
Example response:
{
"data":{"addedContacts":2,"skippedContacts":0,"errors":[]}
}HTTP Request
POST /api/market-analysis/upload-template
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| file | required | |||
| new_job_statistic | required | bool | ||
| job_statistic | required | string | ||
| replace_old_data | required | bool |
Get Job Statistic Categories
Example response:
{
"data": [
{
"id": 1,
"name": "category_1",
"created_at": "30-05-2022 10:56:10",
"updated_at": "30-05-2022 10:56:10"
},
{
"id": 2,
"name": "category_2",
"created_at": "30-05-2022 10:59:03",
"updated_at": "30-05-2022 10:59:03"
}
]
}HTTP Request
Get /api/market-analysis/job-statistic-categories
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| name | string | optional | for search |
Display Job Statistic Category
Example response:
{
"data": {
"id": 1,
"name": "Job statistic name 1",
"created_at": "06-06-2022 13:33:17",
"updated_at": "06-06-2022 13:33:17"
}
}HTTP Request
Get /api/market-analysis/job-statistic-categories/{id}
Market Search
Example response:
{
"data": [
{
"position_type": "developer"
},
{
"position_type": "php developer"
},
{
"position_type": "mobile developer"
},
{
"position_type": "ios developer"
}
]
}
HTTP Request
GET /api/market-analysis/search
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| search | required | |||
| location | nullable |
Market get positions number
Example response:
{
"data": {
"position_count": [
2
],
"position_numbers": [
5
],
"average_salaries": [
2
],
"position_type": [
"php developer",
"php developer"
],
"location": [
"Egypt, London",
"Alex"
],
"top_employers": [
"Olwg",
"Heroes"
],
"position_titles": [
"php developer",
"php developer"
]
}
}HTTP Request
POST /api/market-analysis/positions
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| position | required | |||
| location |
Market get Location on positions
Example response:
{
"data": [
{
"location": "London, England, United Kingdom"
},
{
"location": "London Area, United Kingdom"
}
]
}HTTP Request
POST /api/market-analysis/location-search
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| search | required | |||
| position | required |
Get Brand Analysis
Example response:
{
"data": {
"position_count": [
2
],
"position_numbers": [
5
],
"average_salaries": [
2
],
"position_type": [
"php developer",
"php developer"
],
"location": [
"Egypt, London",
"Alex"
],
"top_employers": [
"Olwg",
"Heroes"
],
"position_titles": [
"php developer",
"php developer"
]
}
}HTTP Request
GET /api/brand-analysis
Parameters
| Parameter | Type | Status | Description |
|---|
Create Brand Analysis
Example response:
{
"data": {
"message": "messages.BrandAnalysis have created successfully",
"data": {
"company_name": "asdasdsf",
"location": "asdasdsf",
"overall_rating": "-3",
"approve_of_ceo": "1",
"recommend_to_a_friend": "1",
"work_life_balance_ranking": "3.5",
"pay_benefits_ranking": "2.4",
"job_security_advancement_ranking": "2.5",
"management_ranking": "3.3",
"culture_ranking": "1.3",
"top_3_reviews_by_date": "asdasdsf",
"url": "asdasdsf",
"updated_at": "04-10-2021 08:22:01",
"created_at": "04-10-2021 08:22:01",
"id": 3
}
}
}HTTP Request
POST /api/brand-analysis
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| company_name | required | max:128 | ||
| location | required | max:128 | ||
| overall_rating | required | numeric | max:5 | |
| work_life_balance_ranking | required | numeric | max:5 | |
| pay_benefits_ranking | required | numeric | max:5 | |
| job_security_advancement_ranking | required | numeric | max:5 | |
| management_ranking | required | numeric | max:5 | |
| culture_ranking | required | numeric | max:5 | |
| top_3_reviews_by_date | required | |||
| diversity_score | integer |
Update Brand Analysis
Example response:
{
"data": {
"message": "BrandAnalysis updated successfully",
"data": {
"id": 5,
"company_name": "asdasdsf",
"location": "asdasdsf",
"overall_rating": "-3",
"approve_of_ceo": "1",
"recommend_to_a_friend": "1",
"work_life_balance_ranking": "3.5",
"pay_benefits_ranking": "2.4",
"job_security_advancement_ranking": "2.5",
"management_ranking": "3.3",
"culture_ranking": "1.3",
"top_3_reviews_by_date": "asdasdsf",
"url": "asdasdsf",
"created_at": "04-10-2021 10:33:29",
"updated_at": "04-10-2021 11:16:13"
},
"status_code": 200
}
}HTTP Request
PUT /api/brand-analysis/{id}
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| company_name | required | max:128 | ||
| location | required | max:128 | ||
| overall_rating | required | numeric | max:5 | |
| work_life_balance_ranking | required | numeric | max:5 | |
| pay_benefits_ranking | required | numeric | max:5 | |
| job_security_advancement_ranking | required | numeric | max:5 | |
| management_ranking | required | numeric | max:5 | |
| culture_ranking | required | numeric | max:5 | |
| top_3_reviews_by_date | required | |||
| diversity_score | integer |
DELETE Brand Analysis
Example response:
{
"data": {
"message": "BrandAnalysis deleted successfully",
"data": null,
"status_code": 200
}
}HTTP Request
DELETE /api/brand-analysis/{id}
Parameters
| Parameter | Type | Status | Description |
|---|
Download Brand Analysis Template
Example response:
{
download file
}HTTP Request
GET /api/brand-analysis/download-template
Parameters
| Parameter | Type | Status | Description |
|---|
Import Brand Analysis Template
Example response:
{
"data":{"addedContacts":2,"skippedContacts":0,"errors":[]}
}HTTP Request
POST /api/brand-analysis/upload-template
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| file | required |
Brand Search
Example response:
{
"data": {
"id": 1,
"company_name": "Microsoft",
"location": "Dublin, Ireland",
"overall_rating": 4.2,
"work_life_balance_ranking": 3.9,
"pay_benefits_ranking": 4.1,
"job_security_advancement_ranking": 3.5,
"management_ranking": 3.6,
"culture_ranking": 4,
"top_3_reviews_by_date": "List header , of top 3 to , 5 reviews",
"diversity_score": "100",
"created_at": "06-10-2021 14:45:59",
"updated_at": "06-10-2021 14:45:59"
}
}HTTP Request
GET /api/brand-analysis/search
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| search | required |
Talent Search
Example response:
{
"interestsTargeting": {
"Frequent travellers": [
{
"users": 368400,
"users_lower_bound": 350000,
"users_upper_bound": 368400,
"estimate_ready": true
}
],
"Music": [
{
"users": 813400,
"users_lower_bound": 801000,
"users_upper_bound": 843200,
"estimate_ready": true
}
]
},
"skillsTargeting": {
"Sales Director": [
{
"users": 1000,
"users_lower_bound": 1000,
"users_upper_bound": 1000,
"estimate_ready": true
}
],
"Leadership": [
{
"users": 821200,
"users_lower_bound": 806300,
"users_upper_bound": 848700,
"estimate_ready": true
}
],
"Sales management": [
{
"users": 15200,
"users_lower_bound": 15200,
"users_upper_bound": 16300,
"estimate_ready": true
}
]
},
"total_potential_number": {
"users": 8300000,
"users_lower_bound": 8300000,
"users_upper_bound": 8800000,
"estimate_ready": true
},
"country_total_shortlist_number": {
"users": 490100,
"users_lower_bound": 479500,
"users_upper_bound": 504800,
"estimate_ready": true
},
"city_total_shortlist_number": {
"users": 830900,
"users_lower_bound": 816700,
"users_upper_bound": 859700,
"estimate_ready": true
},
"men_data": {
"users": 361700,
"users_lower_bound": 355000,
"users_upper_bound": 373700,
"estimate_ready": true
},
"women_data": {
"users": 470500,
"users_lower_bound": 449900,
"users_upper_bound": 473600,
"estimate_ready": true
},
"years_of_experience_1_3": {
"users": 145100,
"users_lower_bound": 145100,
"users_upper_bound": 157100,
"estimate_ready": true
},
"years_of_experience_3_6": {
"users": 184100,
"users_lower_bound": 183700,
"users_upper_bound": 193300,
"estimate_ready": true
},
"years_of_experience_6": {
"users": 545300,
"users_lower_bound": 527500,
"users_upper_bound": 555200,
"estimate_ready": true
}
}HTTP Request
POST /api/talent-analysis/search
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| source | string | nullable | facebook, instagram | |
| countries | array | required | distance_unit, key, name, type, radius, country | |
| cities | array | required | distance_unit, key, name, type, region, region_id, radius, country | |
| jobs | array | required | interests object has (id, name, type) | |
| skills | array | required | interests object has (id, name, type) | |
| interests | array | required | interests object has (id, name, type) |
Talent save audience Search
Example response:
{
"data": {
"message": "Audience Created successfully",
"data": null
}
}HTTP Request
POST /api/talent-analysis/save-audience
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| name | string | required | ||
| countries | array | required | distance_unit, key, name, type, radius, country | |
| cities | array | required | distance_unit, key, name, type, region, region_id, radius, country | |
| jobs | array | required | interests object has (id, name, type) | |
| skills | array | required | interests object has (id, name, type) | |
| interests | array | required | interests object has (id, name, type) |
Report analysis by weeks
Example response:
{
"data": {
"1": [
{
"clicks": "742",
"ctr": "4",
"reaches": "23160",
"engagement": "404",
"lead_generation": null,
"video_view": null
}
],
"2": [
{
"clicks": "371",
"ctr": "2",
"reaches": "11580",
"engagement": "202",
"lead_generation": null,
"video_view": null
}
]
}
}HTTP Request
POST /api/report-analysis/{campaignId}
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| start_date | date | required | ||
| end_date | date | required |
Export campaign metrics report
Example response:
{
'doownload file'
}HTTP Request
POST /api/report-analysis/{campaignId}/export
Parameters
| Parameter | Type | Status | Description | |
|---|---|---|---|---|
| start_date | date | required | ||
| end_date | date | required |
Dashboard Analysis Statistics
Example response:
{
"data": {
"reaches": 69480,
"clicks": 2226,
"engagement": 1212,
"applications": 0
}
}HTTP Request
GET /api/analysis/statistics
Parameters
| Parameter | Type | Status | Description |
|---|
Linkedin Lists
List Locations
Example response:
{
"data": {
"paging": {
"start": 0,
"count": 2,
"total": 9
},
"elements": [
{
"name": "Egypt",
"urn": "urn:li:geo:106155005",
"facetUrn": "urn:li:adTargetingFacet:locations"
},
{
"name": "Cairo, Egypt",
"urn": "urn:li:geo:102007122",
"facetUrn": "urn:li:adTargetingFacet:locations"
}
]
}
}HTTP Request
GET /api/linkedin/locations
Parameters
| Parameter | Type | Status | Description | Default |
|---|---|---|---|---|
| query | string | required | Search by entity name | --- |
| start | int | optional | The index of the first item you want results for. | 0 |
| count | int | optional | The number of items you want included on each page of results. There could be fewer items remaining than the value you specify. | 2147483647 |
List Categories
This endpoint search for
company category,company industoryorcompany nameExample response:
{
"data": {
"elements": [
{
"name": "London Stock Exchange (Worldwide)",
"urn": "urn:li:organizationRankingList:400",
"facetUrn": "urn:li:adTargetingFacet:companyCategory",
"type": "Company Category"
},
{
"name": "London Business School",
"urn": "urn:li:organization:5954",
"facetUrn": "urn:li:adTargetingFacet:employers",
"type": "Company Name"
}
]
}
}HTTP Request
GET /api/linkedin/categories
Parameters
| Parameter | Type | Status | Description | Default |
|---|---|---|---|---|
| query | string | required | Search by entity name | --- |
| type | string | optional | Search by list type | supported values: company_category, industry, company_name |
| start | int | optional | The index of the first item you want results for. | 0 |
| count | int | optional | The number of items you want included on each page of results. There could be fewer items remaining than the value you specify. | 2147483647 |
List Job Titles
Example response:
{
"data": {
"paging": {
"start": 0,
"count": 2,
"total": 10
},
"elements": [
{
"name": "Assistant",
"urn": "urn:li:title:34",
"facetUrn": "urn:li:adTargetingFacet:titles"
},
{
"name": "Associate",
"urn": "urn:li:title:23",
"facetUrn": "urn:li:adTargetingFacet:titles"
}
]
}
}HTTP Request
GET /api/linkedin/titles
Parameters
| Parameter | Type | Status | Description | Default |
|---|---|---|---|---|
| query | string | required | Search by entity name | --- |
| duration | string | optional | values: "current", "past", "all" | current |
| start | int | optional | The index of the first item you want results for. | 0 |
| count | int | optional | The number of items you want included on each page of results. There could be fewer items remaining than the value you specify. | 2147483647 |
List Job Functions
Example response:
{
"data": {
"paging": {
"start": 0,
"count": 2,
"total": 26
},
"elements": [
{
"name": "Accounting",
"urn": "urn:li:function:1",
"facetUrn": "urn:li:adTargetingFacet:jobFunctions"
},
{
"name": "Administrative",
"urn": "urn:li:function:2",
"facetUrn": "urn:li:adTargetingFacet:jobFunctions"
}
]
}
}HTTP Request
GET /api/linkedin/jobFunctions
Parameters
| Parameter | Type | Status | Description | Default |
|---|---|---|---|---|
| query | string | optional | Search by entity name | --- |
| start | int | optional | The index of the first item you want results for. | 0 |
| count | int | optional | The number of items you want included on each page of results. There could be fewer items remaining than the value you specify. | 2147483647 |
List Skills
Example response:
{
"data": {
"paging": {
"start": 0,
"count": 2,
"total": 10
},
"elements": [
{
"name": "A++",
"urn": "urn:li:skill:36987",
"facetUrn": "urn:li:adTargetingFacet:skills"
},
{
"name": "Adobe Photoshop",
"urn": "urn:li:skill:281",
"facetUrn": "urn:li:adTargetingFacet:skills"
}
]
}
}HTTP Request
GET /api/linkedin/skills
Parameters
| Parameter | Type | Status | Description | Default |
|---|---|---|---|---|
| query | string | required | Search by entity name | --- |
| start | int | optional | The index of the first item you want results for. | 0 |
| count | int | optional | The number of items you want included on each page of results. There could be fewer items remaining than the value you specify. | 2147483647 |
List Interests
Example response:
{
"data": {
"paging": {
"start": 0,
"count": 2,
"total": 20
},
"elements": [
{
"name": "Seasonal and Temporary Jobs",
"urn": "urn:li:interest:1537706",
"facetUrn": "urn:li:adTargetingFacet:interests",
"type": "Interests"
},
{
"name": "Job Seekers",
"urn": "urn:li:memberBehavior:12",
"facetUrn": "urn:li:adTargetingFacet:memberBehaviors",
"type": "Member behaviors"
}
]
}
}HTTP Request
GET /api/linkedin/interests
Parameters
| Parameter | Type | Status | Description | Default |
|---|---|---|---|---|
| query | string | optional | Search by entity name | --- |
| start | int | optional | The index of the first item you want results for. | 0 |
| count | int | optional | The number of items you want included on each page of results. There could be fewer items remaining than the value you specify. | 2147483647 |
List Years of experience
Example response:
{
"data": {
"paging": {
"start": 0,
"count": 2,
"total": 12
},
"elements": [
{
"name": "1 year",
"year": 1,
"urn": "urn:li:yearsOfExperience:1",
"facetUrn": "urn:li:adTargetingFacet:yearsOfExperienceRanges"
},
{
"name": "2 years",
"year": 2,
"urn": "urn:li:yearsOfExperience:2",
"facetUrn": "urn:li:adTargetingFacet:yearsOfExperienceRanges"
}
]
}
}HTTP Request
GET /api/linkedin/yearsOfExperienceRanges
Parameters
| Parameter | Type | Status | Description | Default |
|---|---|---|---|---|
| start | int | optional | The index of the first item you want results for. | 0 |
| count | int | optional | The number of items you want included on each page of results. There could be fewer items remaining than the value you specify. | 2147483647 |
List Languages
Example response:
{
"data": {
"paging": {
"start": 0,
"count": 2,
"total": 22
},
"elements": [
{
"name": "Arabic",
"urn": "urn:li:locale:ar_AE",
"facetUrn": "urn:li:adTargetingFacet:interfaceLocales"
},
{
"name": "Czech",
"urn": "urn:li:locale:cs_CZ",
"facetUrn": "urn:li:adTargetingFacet:interfaceLocales"
}
]
}
}HTTP Request
GET /api/linkedin/interfaceLocales
Parameters
| Parameter | Type | Status | Description | Default |
|---|---|---|---|---|
| query | string | required | Search by entity name | --- |
| start | int | optional | The index of the first item you want results for. | 0 |
| count | int | optional | The number of items you want included on each page of results. There could be fewer items remaining than the value you specify. | 2147483647 |
List Fields Of Study
Example response:
{
"data": {
"paging": {
"start": 0,
"count": 2,
"total": 10
},
"elements": [
{
"name": "Business Administration and Management, General",
"urn": "urn:li:fieldOfStudy:101409",
"facetUrn": "urn:li:adTargetingFacet:fieldsOfStudy"
},
{
"name": "Electrical and Electronics Engineering",
"urn": "urn:li:fieldOfStudy:100351",
"facetUrn": "urn:li:adTargetingFacet:fieldsOfStudy"
}
]
}
}HTTP Request
GET /api/linkedin/fieldsOfStudy
Parameters
| Parameter | Type | Status | Description | Default |
|---|---|---|---|---|
| query | string | required | Search by entity name | --- |
| start | int | optional | The index of the first item you want results for. | 0 |
| count | int | optional | The number of items you want included on each page of results. There could be fewer items remaining than the value you specify. | 2147483647 |
List Seniorities
Example response:
{
"data": {
"elements": [
{
"name": "Junior",
"urn": "urn:li:yearsOfExperience:2"
},
{
"name": "Mid level",
"urn": "urn:li:yearsOfExperience:6"
},
{
"name": "Senior",
"urn": "urn:li:yearsOfExperience:12"
}
]
}
}HTTP Request
GET /api/linkedin/seniorities
Get Linkedin Results
Example response:
{
"data": {
"total": 3800,
"locations": [
{
"name": "United States",
"country_code": "US",
"total": 3800
},
{
"name": "Egypt",
"country_code": "EG",
"total": 0
}
],
"titles": [
{
"name": "Software Engineer",
"total": 3300
},
{
"name": "Assistant",
"total": 2800
}
],
"job_functions": [
{
"name": "Administrative",
"total": 3800
}
],
"seniorities": [
{
"name": "Junior",
"total": 0
},
{
"name": "Mid Level",
"total": 680
},
{
"name": "Senior",
"total": 3000
}
],
"skills": [
{
"name": "Microsoft Excel",
"total": 3800
}
],
"interests": [
{
"name": "Starting a Business",
"total": 3800
},
{
"name": "Recently Relocated",
"total": 3800
}
],
"educations": [
{
"name": "Business Administration and Management, General",
"total": 3800
}
],
"company_names": [
{
"name": "Google",
"total": 3800
}
],
"company_categories": [
{
"name": "Fortune Global 500 (Worldwide)",
"total": 3800
}
],
"company_industries": [
{
"name": "Oil Extraction",
"total": 3800
}
],
"genders": [
{
"name": "Female",
"total": 1900
},
{
"name": "Male",
"total": 1600
}
]
}
}HTTP Request
GET /api/linkedin/search
Parameters
| Parameter | Type | Status |
|---|---|---|
| search[include] | string[][] | required |
| search[exclude] | string[][] | optional |
Example Request:
{
"search": {
"include": [
[
"urn:li:geo:103644278",
"urn:li:geo:106155005"
],
[
"urn:li:locale:en_US"
],
[
"urn:li:title:9",
"urn:li:title:34",
"urn:li:function:2"
],
[
"urn:li:skill:163"
],
[
"urn:li:interest:1538402",
"urn:li:memberBehavior:15"
],
[
"urn:li:yearsOfExperience:2",
"urn:li:yearsOfExperience:6",
"urn:li:yearsOfExperience:12"
],
[
"urn:li:fieldOfStudy:101409"
],
[
"urn:li:organization:1441",
"urn:li:organizationRankingList:1",
"urn:li:industry:3095"
]
],
"exclude": [
"urn:li:title:24"
]
}
}Notes:
- The relation between the separate include arrays is "AND".
- The relation between urns in the same array is "OR".
- The relation between urns in exclude array is "OR".