stats.overview

get/v1/stats/overview

stats.overview

Request

Parameters

Name	In	Type	Description
from	query	string	No description
to	query	string	No description

Responses

200Return default stats instead of crashing

Schema

Schema Structure

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "success": {
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "period": {
              "type": "object",
              "properties": {
                "from": {
                  "type": "string"
                },
                "to": {
                  "type": "string",
                  "format": "date-time"
                }
              },
              "required": [
                "from",
                "to"
              ]
            },
            "credits": {
              "type": "object",
              "properties": {
                "used": {
                  "type": "integer",
                  "enum": [
                    0
                  ]
                },
                "remaining": {
                  "type": "number"
                },
                "limit": {
                  "type": "integer",
                  "enum": [
                    999999
                  ]
                }
              },
              "required": [
                "used",
                "remaining",
                "limit"
              ]
            },
            "api_calls": {
              "type": "object",
              "properties": {
                "total": {
                  "type": "integer",
                  "enum": [
                    0
                  ]
                },
                "by_endpoint": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "minItems": 0,
                  "maxItems": 0,
                  "additionalItems": false
                }
              },
              "required": [
                "total",
                "by_endpoint"
              ]
            },
            "images": {
              "type": "object",
              "properties": {
                "processed": {
                  "type": "integer",
                  "enum": [
                    0
                  ]
                },
                "total_savings_mb": {
                  "type": "integer",
                  "enum": [
                    0
                  ]
                },
                "average_savings_percent": {
                  "type": "integer",
                  "enum": [
                    0
                  ]
                }
              },
              "required": [
                "processed",
                "total_savings_mb",
                "average_savings_percent"
              ]
            },
            "videos": {
              "type": "object",
              "properties": {
                "rendered": {
                  "type": "integer",
                  "enum": [
                    0
                  ]
                },
                "total_duration_seconds": {
                  "type": "integer",
                  "enum": [
                    0
                  ]
                },
                "average_render_time_seconds": {
                  "type": "integer",
                  "enum": [
                    0
                  ]
                }
              },
              "required": [
                "rendered",
                "total_duration_seconds",
                "average_render_time_seconds"
              ]
            },
            "social": {
              "type": "object",
              "properties": {
                "posts_published": {
                  "type": "integer",
                  "enum": [
                    0
                  ]
                },
                "total_engagement": {
                  "type": "integer",
                  "enum": [
                    0
                  ]
                },
                "top_platform": {
                  "type": "string",
                  "enum": [
                    "none"
                  ]
                }
              },
              "required": [
                "posts_published",
                "total_engagement",
                "top_platform"
              ]
            }
          },
          "required": [
            "period",
            "credits",
            "api_calls",
            "images",
            "videos",
            "social"
          ]
        }
      },
      "required": [
        "success",
        "data"
      ]
    },
    {
      "type": "object",
      "properties": {
        "success": {
          "type": "boolean"
        },
        "data": {
          "type": "object",
          "properties": {
            "period": {
              "type": "object",
              "properties": {
                "from": {},
                "to": {}
              },
              "required": [
                "from",
                "to"
              ]
            },
            "credits": {
              "type": "object",
              "properties": {
                "used": {
                  "type": "number"
                },
                "remaining": {
                  "type": "number"
                },
                "limit": {
                  "type": "number"
                }
              },
              "required": [
                "used",
                "remaining",
                "limit"
              ]
            },
            "api_calls": {
              "type": "object",
              "properties": {
                "total": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "integer",
                      "enum": [
                        0
                      ]
                    }
                  ]
                },
                "by_endpoint": {
                  "anyOf": [
                    {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "minItems": 0,
                      "maxItems": 0,
                      "additionalItems": false
                    },
                    {
                      "type": "object",
                      "properties": {
                        "/images/compress": {
                          "type": "string"
                        },
                        "/videos/render": {
                          "type": "string"
                        },
                        "/social/posts": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "/images/compress",
                        "/videos/render",
                        "/social/posts"
                      ]
                    }
                  ]
                }
              },
              "required": [
                "total",
                "by_endpoint"
              ]
            },
            "images": {
              "type": "object",
              "properties": {
                "processed": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "integer",
                      "enum": [
                        0
                      ]
                    }
                  ]
                },
                "total_savings_mb": {
                  "type": "number"
                },
                "average_savings_percent": {
                  "type": "number"
                }
              },
              "required": [
                "processed",
                "total_savings_mb",
                "average_savings_percent"
              ]
            },
            "videos": {
              "type": "object",
              "properties": {
                "rendered": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "integer",
                      "enum": [
                        0
                      ]
                    }
                  ]
                },
                "total_duration_seconds": {
                  "type": "integer"
                },
                "average_render_time_seconds": {
                  "type": "integer"
                }
              },
              "required": [
                "rendered",
                "total_duration_seconds",
                "average_render_time_seconds"
              ]
            },
            "social": {
              "type": "object",
              "properties": {
                "posts_published": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "integer",
                      "enum": [
                        0
                      ]
                    }
                  ]
                },
                "total_engagement": {
                  "type": "integer",
                  "enum": [
                    0
                  ]
                },
                "top_platform": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "string",
                      "enum": [
                        "none"
                      ]
                    }
                  ]
                }
              },
              "required": [
                "posts_published",
                "total_engagement",
                "top_platform"
              ]
            }
          },
          "required": [
            "period",
            "credits",
            "api_calls",
            "images",
            "videos",
            "social"
          ]
        }
      },
      "required": [
        "success",
        "data"
      ]
    }
  ]
}