Update a report

curl --request PUT \
  --url https://api.avidoai.com/v0/reporting/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "title": "Q1 2025 Performance Report"
}
'

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "orgId": "org_123456",
    "applicationId": "456e7890-e89b-12d3-a456-426614174000",
    "title": "Q1 2025 Performance Report",
    "description": "Updated analysis with new data and insights",
    "assignee": "user_345678",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T14:22:33.456Z"
  }
}

{
  "message": "Resource not found"
}

{
  "message": "Resource not found"
}

{
  "message": "Resource not found"
}

{
  "message": "Resource not found"
}

{
  "message": "Invalid request data",
  "issues": [
    {
      "code": "invalid_string",
      "message": "Invalid UUID",
      "path": [
        "id"
      ]
    }
  ]
}

{
  "message": "Resource not found"
}

PUT

reporting

{id}

curl --request PUT \
  --url https://api.avidoai.com/v0/reporting/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "title": "Q1 2025 Performance Report"
}
'

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "orgId": "org_123456",
    "applicationId": "456e7890-e89b-12d3-a456-426614174000",
    "title": "Q1 2025 Performance Report",
    "description": "Updated analysis with new data and insights",
    "assignee": "user_345678",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T14:22:33.456Z"
  }
}

{
  "message": "Resource not found"
}

{
  "message": "Resource not found"
}

{
  "message": "Resource not found"
}

{
  "message": "Resource not found"
}

{
  "message": "Invalid request data",
  "issues": [
    {
      "code": "invalid_string",
      "message": "Invalid UUID",
      "path": [
        "id"
      ]
    }
  ]
}

{
  "message": "Resource not found"
}

Authorizations

x-api-key

string

header

required

Your unique Avido API key

x-application-id

string

header

required

Your unique Avido Application ID

Path Parameters

string<uuid>

required

The unique identifier of the report

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json

Request body for updating a report

title

string

Updated title of the report

Example:

"Q1 2025 Performance Report"

description

string

Updated description of the report

Example:

"Updated analysis including new metrics"

assignee

string · null · null

Updated assignee user ID (can be set to null to unassign)

Example:

"user_345678"

query

ReportingQuery · object · null · null

Updated reporting query configuration (can be set to null to clear)

Show child attributes

Response

Successfully updated report

Successful response containing the report data

data

Report · object

required

A report for tracking and analyzing AI application performance

Show child attributes

Get a single report Delete a report