Apps

Create and retrieve Projects is needed to get the ingestion key.

List Apps

GET https://app.inspector.dev/api/apps

Headers

Name	Type	Description
Authentication*	string	API key.

200

[
    {
        "id": 123,
        "name": "App Demo",
        "favorite": false,
        "client_version": "4.7.33",
        "key": "xxxxxxxxxxxxxxxxx",
        "serverless": false,
        "weekly_report": true,
        "platform": {
            "id": 1,
            "name": "Laravel",
            "language": "PHP"
        },
        "users": [1, 2],
        "created_at": "2024-03-01 10:52",
        "updated_at": "2024-03-01 10:52"
    },
    {
        "id": 456,
        "name": "Demo 2",
        "favorite": false,
        "key": "xxxxxxxxxxxxxxxxx",
        
        ...
    }
]

App Details

GET https://app.inspector.dev/api/apps/:id

Path Parameters

Name	Type	Description
id*	integer	App's ID

Headers

Name	Type	Description
Authentication*	string	API key

200

{
    "id": 123,
    "name": "App Demo",
    "favorite": false,
    "client_version": "4.7.33",
    "key": "xxxxxxxxxxxxxxxxx",
    "serverless": false,
    "weekly_report": true,
    "platform": {
        "id": 1,
        "name": "Laravel",
        "language": "PHP"
    },
    "users": [1, 2],
    "created_at": "2024-03-01 10:52",
    "updated_at": "2024-03-01 10:52"
}

404

{
    "message": "Resource not found."
}

Create App

POST https://app.inspector.dev/api/apps

Create a new project will generate a new ingestion key.

Headers

Name	Type	Description
Authentication*	string	API key

Request Body

Name	Type	Description
name*	string	The name of the project
platform_id*	integer	The ID of the technology stack used for the project

200

{
    "id": 123,
    "name": "App Demo",
    "favorite": false,
    "client_version": "4.7.33",
    "key": "xxxxxxxxxxxxxxxxx",
    "serverless": false,
    "weekly_report": true,
    "platform": {
        "id": 1,
        "name": "Laravel",
        "language": "PHP"
    },
    "users": [1, 2],
    "created_at": "2024-03-01 10:52",
    "updated_at": "2024-03-01 10:52"
}

422 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"
        ]
    }
}

Update App

PUT https://app.inspector.dev/api/apps/:id

Path Parameters

Name	Type	Description
id*	integer	App's ID

Headers

Name	Type	Description
Authentication*	string	API key

Request Body

Name	Type	Description
weekly_report	boolean	Determine if you want to receive the weekly summary via email.
platform_id*	integer	The tech stack.
name*	string	Name of the project

200

{
    "id": 123,
    "name": "App Demo",
    "favorite": false,
    "client_version": "4.7.33",
    "key": "xxxxxxxxxxxxxxxxx",
    "serverless": false,
    "weekly_report": true,
    "platform": {
        "id": 1,
        "name": "Laravel",
        "language": "PHP"
    },
    "users": [1, 2],
    "created_at": "2024-03-01 10:52",
    "updated_at": "2024-03-01 10:52"
}

Delete App

DELETE https://app.inspector.dev/api/apps/:id

Path Parameters

Name	Type	Description
id*	integer	App's ID

Headers

Name	Type	Description
Authorization*	string	API key

200

{
    "id": 123,
    "name": "App Demo",
    "favorite": false,
    "client_version": "4.7.33",
    "key": "xxxxxxxxxxxxxxxxx",
    "serverless": false,
    "weekly_report": true,
    "platform": {
        "id": 1,
        "name": "Laravel",
        "language": "PHP"
    },
    "users": [1, 2],
    "created_at": "2024-03-01 10:52",
    "updated_at": "2024-03-01 10:52"
}

Enable/Disable Data Transfer

POST /https://app.inspector.dev/api/apps/:id/lock

The endpoint works as a toggle. To know if your application is currently locked or not you can check the locked_at field in the app object. If it exists that means the application monitoring is currently off, and the next call to the lock endpoint will turn it on.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Response

200

{
  "id": 123,
    "name": "App Demo",
    "favorite": false,
    "client_version": "4.7.33",
    "key": "xxxxxxxxxxxxxxxxx",
    "serverless": false,
    "weekly_report": true,
    "platform": {
        "id": 1,
        "name": "Laravel",
        "language": "PHP"
    },
    "users": [1, 2],
    "locked_at": "2025-01-29 11:53",
    "created_at": "2024-03-01 10:52",
    "updated_at": "2024-03-01 10:52"
}

401

{
  "error": "Unauthorized action."
}