Dashboard

Access dashboard widgets and analytics data for business intelligence and reporting.

Quick Reference

Method	Endpoint	Description
GET	/api/dashboard
GET	/api/dashboard/gridviewstate/{id}
POST	/api/dashboard/gridviewstate/{id}
GET	/api/dashboard/gridviews
POST	/api/dashboard/inbound
POST	/api/dashboard/recentestimates
POST	/api/dashboard/inhouse
POST	/api/dashboard/outbound
POST	/api/dashboard/local-deliveries
POST	/api/dashboard/incrementjobstatus
POST	/api/dashboard/undoincrementjobstatus
GET	/api/dashboard/gridsettings
POST	/api/dashboard/gridsettings

GET /api/dashboard

Parameters:

Query Parameters:

viewId (integer, query): No description available
companyId (string, query): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/dashboard"

)

# Process the response
print(response)

ab api raw get /api/dashboard

curl -X GET \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  'https://api.abconnect.co/api/dashboard'

Sample Response:

{
  "status": "success",
  "data": {}
}

GET /api/dashboard/gridviewstate/{id}

Parameters:

Path Parameters:

id (integer, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/dashboard/gridviewstate/{id}"
,
    id=789e0123-e89b-12d3-a456-426614174002

)

# Process the response
print(response)

ab api raw get /api/dashboard/gridviewstate/{id} \
    id=789e0123-e89b-12d3-a456-426614174002

curl -X GET \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  'https://api.abconnect.co/api/dashboard/gridviewstate/789e0123-e89b-12d3-a456-426614174002'

Sample Response:

1{}

POST /api/dashboard/gridviewstate/{id}

Parameters:

Path Parameters:

id (integer, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/dashboard/gridviewstate/{id}"
,
    id=789e0123-e89b-12d3-a456-426614174002
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

ab api raw post /api/dashboard/gridviewstate/{id} \
    id=789e0123-e89b-12d3-a456-426614174002

curl -X POST \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "example": "data"
  }' \
  'https://api.abconnect.co/api/dashboard/gridviewstate/789e0123-e89b-12d3-a456-426614174002'

Sample Response:

1{}

GET /api/dashboard/gridviews

Parameters:

Query Parameters:

companyId (string, query): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/dashboard/gridviews"

)

# Process the response
print(response)

ab api raw get /api/dashboard/gridviews

curl -X GET \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  'https://api.abconnect.co/api/dashboard/gridviews'

Sample Response:

1[]

POST /api/dashboard/inbound

Parameters:

Query Parameters:

companyId (string, query): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/dashboard/inbound"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

ab api raw post /api/dashboard/inbound

curl -X POST \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "example": "data"
  }' \
  'https://api.abconnect.co/api/dashboard/inbound'

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

POST /api/dashboard/recentestimates

Parameters:

Query Parameters:

companyId (string, query): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/dashboard/recentestimates"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

ab api raw post /api/dashboard/recentestimates

curl -X POST \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "example": "data"
  }' \
  'https://api.abconnect.co/api/dashboard/recentestimates'

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

POST /api/dashboard/inhouse

Parameters:

Query Parameters:

companyId (string, query): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/dashboard/inhouse"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

ab api raw post /api/dashboard/inhouse

curl -X POST \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "example": "data"
  }' \
  'https://api.abconnect.co/api/dashboard/inhouse'

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

POST /api/dashboard/outbound

Parameters:

Query Parameters:

companyId (string, query): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/dashboard/outbound"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

ab api raw post /api/dashboard/outbound

curl -X POST \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "example": "data"
  }' \
  'https://api.abconnect.co/api/dashboard/outbound'

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

POST /api/dashboard/local-deliveries

Parameters:

Query Parameters:

companyId (string, query): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/dashboard/local-deliveries"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

ab api raw post /api/dashboard/local-deliveries

curl -X POST \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "example": "data"
  }' \
  'https://api.abconnect.co/api/dashboard/local-deliveries'

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

POST /api/dashboard/incrementjobstatus

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/dashboard/incrementjobstatus"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

ab api raw post /api/dashboard/incrementjobstatus

curl -X POST \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "example": "data"
  }' \
  'https://api.abconnect.co/api/dashboard/incrementjobstatus'

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

POST /api/dashboard/undoincrementjobstatus

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/dashboard/undoincrementjobstatus"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

ab api raw post /api/dashboard/undoincrementjobstatus

curl -X POST \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "example": "data"
  }' \
  'https://api.abconnect.co/api/dashboard/undoincrementjobstatus'

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

GET /api/dashboard/gridsettings

Parameters:

Query Parameters:

companyId (string, query): No description available
dashboardType (string, query): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/dashboard/gridsettings"

)

# Process the response
print(response)

ab api raw get /api/dashboard/gridsettings

curl -X GET \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  'https://api.abconnect.co/api/dashboard/gridsettings'

Sample Response:

1[]

POST /api/dashboard/gridsettings

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/dashboard/gridsettings"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

ab api raw post /api/dashboard/gridsettings

curl -X POST \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "example": "data"
  }' \
  'https://api.abconnect.co/api/dashboard/gridsettings'

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}