get-cloud-diagrams-stats

dci get-cloud-diagrams-stats [flags]

Returns a list of all diagrams with activity stats for the given time period.

Flags

--start: (string format:date-time)

--end: (string format:date-time)

Responses

200 (application/json)

OK - List of diagrams with stats returned.

{
  "type": "array",
  "items": {
    "type": "object",
    "description": "Diagram with activity stats for a given time period.",
    "properties": {
      "_id": {
        "type": "string",
        "description": "ID of the diagram."
      },
      "ss_id": {
        "type": "string",
        "description": "ID of the statussheet the diagram belongs to."
      },
      "name": {
        "type": "string",
        "description": "Name of the diagram."
      },
      "type": {
        "type": "string",
        "enum": [
          "application",
          "infrastructure",
          "network",
          "template"
        ],
        "description": "Type of the diagram."
      },
      "account_name": {
        "type": "string",
        "description": "Cloud account name."
      },
      "account_id": {
        "type": "string",
        "description": "Cloud account ID."
      },
      "account_type": {
        "type": "string",
        "description": "Cloud account type."
      },
      "changes": {
        "type": "array",
        "description": "Activity changes within the period.",
        "items": {
          "type": "object",
          "description": "A single activity change entry in a diagram stats record.",
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "NODE_CREATE",
                "NODE_UPDATE",
                "NODE_DELETE"
              ],
              "description": "Type of the change."
            },
            "service": {
              "type": "string",
              "description": "Cloud service the change applies to."
            },
            "count": {
              "type": "integer",
              "description": "Number of occurrences of this change type."
            }
          }
        }
      },
      "import": {
        "type": "object",
        "description": "Current import/sync state for a cloud-connected diagram.",
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "queued",
              "in_progress",
              "success",
              "failure"
            ],
            "description": "Import status."
          },
          "type": {
            "type": "string",
            "enum": [
              "AWS",
              "GCP",
              "AZURE"
            ],
            "description": "Connected cloud account type."
          },
          "account": {
            "type": "string",
            "description": "Connected account ID."
          },
          "cloudId": {
            "type": "string",
            "description": "Cloud account ID."
          },
          "errorMessage": {
            "type": "string",
            "description": "Error message if the import failed."
          },
          "syncedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp of the last successful sync."
          }
        }
      }
    }
  }
}

400 (application/json)

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)

Unauthorized - Invalid API key.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: get-cloud-diagrams-stats, getclouddiagramsstats