Inspector
Inspector
Inspector
Inspector
Introduction
Notification Channels
Bookmarks
Alerts
Permissions
Custom Segments
Supported Platforms
PHP
Laravel / Lumen
NodeJS
REST API
Authentication
Projects
Platforms
Analytics
Powered by GitBook

Projects

get
List Projects

https://app.inspector.dev/api/projects
Request
Response
Request
Headers
Authentication
required
string
API key.
Response
200: OK
[
    {
        "id": 13,
        "name": "demo",
        "is_active": true,
        "key": "7dd759e70d019d0a926a4a481dd5e522",
        "quota_consumption": 15
    },
    {
        "id": 14,
        "name": "Demo 2",
        "is_active": true,
        "key": "7dd759e70d019d0a926a4a481dd5e522",
        "quota_consumption": 15
    },
    
    ...
]

get
Project Details

https://app.inspector.dev/api/projects/:id
Request
Response
Request
Path Parameters
id
optional
integer
Project's ID
Headers
Authentication
required
string
API key
Response
200: OK
{
    "id": 13,
    "name": "demo",
    "is_active": true,
    "key": "7dd759e70d019d0a926a4a481dd5e522",
    "quota_consumption": 15,
    "client_version": "4.5.0",
    "platform_id": 2,
    "platform": {
        "id": 2,
        "name": "Laravel",
        "language": "php",
        "client_version": "4.5.0",
        "active": true
    },
    "weekly_report": true,
    "highlighted_transactions": [],
    "created_at": "2020-10-02 16:29:19",
    "updated_at": "2020-10-02 16:29:19"
}
404: Not Found
{
    "message": "Resource not found."
}

post
Create Project

https://app.inspector.dev/api/projects
Create a new project will generate a new ingestion key.
Request
Response
Request
Headers
Authentication
required
string
API key
Body Parameters
name
required
string
The name of the project
platform_id
required
integer
The ID of the technology stack used for the project
Response
200: OK
{
    "id": 13,
    "name": "demo",
    "is_active": true,
    "key": "7dd759e70d019d0a926a4a481dd5e522",
    "quota_consumption": 15,
    "client_version": "4.5.0",
    "platform_id": 2,
    "platform": {
        "id": 2,
        "name": "Laravel",
        "language": "php",
        "client_version": "4.5.0",
        "active": true
    },
    "weekly_report": true,
    "highlighted_transactions": [],
    "created_at": "2020-10-02 16:29:19",
    "updated_at": "2020-10-02 16:29:19"
}
422: Unprocessable Entity
If some data is incorrect.
{
    "message": "The given data are incorrect",
    "errors": {
        "name": [
            "The name field is required",
            "The name field should contains more than 3 characters"
        ]
    }
}

put
Update Project

https://app.inspector.dev/api/projects/:id
Request
Response
Request
Path Parameters
id
required
integer
Project's ID
Headers
Authentication
required
string
API key
Body Parameters
enabled
optional
boolean
Enable / Disable data ingestion directly from your dashboard.
weekly_report
optional
boolean
A flag to determine if you want receive the weekly summary via email for this project.
platform_id
optional
integer
The tech stack used for the project
name
optional
string
Name of the project
Response
200: OK
{
    "id": 13,
    "name": "demo",
    "is_active": true,
    "key": "7dd759e70d019d0a926a4a481dd5e522",
    "quota_consumption": 15,
    "client_version": "4.5.0",
    "platform_id": 2,
    "platform": {
        "id": 2,
        "name": "Laravel",
        "language": "php",
        "client_version": "4.5.0",
        "active": true
    },
    "weekly_report": true,
    "highlighted_transactions": [],
    "created_at": "2020-10-02 16:29:19",
    "updated_at": "2020-10-02 16:29:19"
}

delete
Delete Project

https://app.inspector.dev/api/projects/:id
Request
Response
Request
Path Parameters
id
required
integer
Project's ID
Headers
Authorization
required
string
API key
Response
200: OK
​
REST API - Previous
Authentication
Next - REST API
Platforms
Last updated 2 months ago
Contents
get
List Projects
get
Project Details
post
Create Project
put
Update Project
delete
Delete Project