Skip to content

Commit 255bd69

Browse files
author
github-actions
committed
Update REST API documentation Mon Aug 17 08:24:16 UTC 2026
1 parent 13a8785 commit 255bd69

1 file changed

Lines changed: 183 additions & 108 deletions

File tree

‎restapi.json‎

Lines changed: 183 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -4492,14 +4492,14 @@
44924492
}
44934493
}
44944494
},
4495-
"/api/v2/analytics/dashboard": {
4495+
"/api/v2/analytics/dashboard/summary": {
44964496
"get": {
44974497
"tags": [
44984498
"analytics"
44994499
],
4500-
"summary": "Gets dashboard analytics statistics.",
4501-
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns dashboard cards with aggregate analytics metrics.",
4502-
"operationId": "9d12b324dd31b9672eb96506e88a4147",
4500+
"summary": "Gets dashboard summary statistics.",
4501+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns dashboard summary statistics.",
4502+
"operationId": "3ecb8b72d02b77df67ccbcb3070c82ec",
45034503
"parameters": [
45044504
{
45054505
"name": "php-auth-pw",
@@ -4518,120 +4518,63 @@
45184518
"application/json": {
45194519
"schema": {
45204520
"properties": {
4521-
"summary_statistics": {
4521+
"total_subscribers": {
45224522
"properties": {
4523-
"total_subscribers": {
4524-
"properties": {
4525-
"value": {
4526-
"type": "integer",
4527-
"example": 48294
4528-
},
4529-
"change_vs_last_month": {
4530-
"type": "number",
4531-
"format": "float",
4532-
"example": 12.5
4533-
}
4534-
},
4535-
"type": "object"
4536-
},
4537-
"active_campaigns": {
4538-
"properties": {
4539-
"value": {
4540-
"type": "integer",
4541-
"example": 12
4542-
},
4543-
"change_vs_last_month": {
4544-
"type": "number",
4545-
"format": "float",
4546-
"example": 0
4547-
}
4548-
},
4549-
"type": "object"
4523+
"value": {
4524+
"type": "integer",
4525+
"example": 48294
45504526
},
4551-
"open_rate": {
4552-
"properties": {
4553-
"value": {
4554-
"type": "number",
4555-
"format": "float",
4556-
"example": 12
4557-
},
4558-
"change_vs_last_month": {
4559-
"type": "number",
4560-
"format": "float",
4561-
"example": 0
4562-
}
4563-
},
4564-
"type": "object"
4527+
"change_vs_last_month": {
4528+
"type": "number",
4529+
"format": "float",
4530+
"example": 12.5
4531+
}
4532+
},
4533+
"type": "object"
4534+
},
4535+
"active_campaigns": {
4536+
"properties": {
4537+
"value": {
4538+
"type": "integer",
4539+
"example": 12
45654540
},
4566-
"bounce_rate": {
4567-
"properties": {
4568-
"value": {
4569-
"type": "number",
4570-
"format": "float",
4571-
"example": 12
4572-
},
4573-
"change_vs_last_month": {
4574-
"type": "number",
4575-
"format": "float",
4576-
"example": 0
4577-
}
4578-
},
4579-
"type": "object"
4541+
"change_vs_last_month": {
4542+
"type": "number",
4543+
"format": "float",
4544+
"example": 0
45804545
}
45814546
},
45824547
"type": "object"
45834548
},
4584-
"recent_campaigns": {
4585-
"type": "array",
4586-
"items": {
4587-
"properties": {
4588-
"name": {
4589-
"type": "string",
4590-
"example": "March Newsletter"
4591-
},
4592-
"status": {
4593-
"type": "string",
4594-
"example": "sent",
4595-
"nullable": true
4596-
},
4597-
"date": {
4598-
"type": "string",
4599-
"format": "date",
4600-
"example": "2026-03-15",
4601-
"nullable": true
4602-
},
4603-
"open_rate": {
4604-
"type": "string",
4605-
"example": "42.50%"
4606-
},
4607-
"click_rate": {
4608-
"type": "string",
4609-
"example": "8.10%"
4610-
}
4549+
"open_rate": {
4550+
"properties": {
4551+
"value": {
4552+
"type": "number",
4553+
"format": "float",
4554+
"example": 12
46114555
},
4612-
"type": "object"
4613-
}
4556+
"change_vs_last_month": {
4557+
"type": "number",
4558+
"format": "float",
4559+
"example": 0
4560+
}
4561+
},
4562+
"type": "object"
46144563
},
4615-
"campaign_performance": {
4616-
"type": "array",
4617-
"items": {
4618-
"properties": {
4619-
"date": {
4620-
"type": "string",
4621-
"format": "date",
4622-
"example": "2026-03-19"
4623-
},
4624-
"opens": {
4625-
"type": "integer",
4626-
"example": 234
4627-
},
4628-
"clicks": {
4629-
"type": "integer",
4630-
"example": 57
4631-
}
4564+
"bounce_rate": {
4565+
"properties": {
4566+
"value": {
4567+
"type": "number",
4568+
"format": "float",
4569+
"example": 12
46324570
},
4633-
"type": "object"
4634-
}
4571+
"change_vs_last_month": {
4572+
"type": "number",
4573+
"format": "float",
4574+
"example": 0
4575+
}
4576+
},
4577+
"type": "object"
46354578
}
46364579
},
46374580
"type": "object"
@@ -4652,6 +4595,138 @@
46524595
}
46534596
}
46544597
},
4598+
"/api/v2/analytics/dashboard/recent-campaigns": {
4599+
"get": {
4600+
"tags": [
4601+
"analytics"
4602+
],
4603+
"summary": "Gets dashboard recent campaigns statistics.",
4604+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns the most recent campaigns with their performance metrics.",
4605+
"operationId": "c5c93fc6bac24a4f506a5d0ded25bb55",
4606+
"parameters": [
4607+
{
4608+
"name": "php-auth-pw",
4609+
"in": "header",
4610+
"description": "Session key obtained from login",
4611+
"required": true,
4612+
"schema": {
4613+
"type": "string"
4614+
}
4615+
}
4616+
],
4617+
"responses": {
4618+
"200": {
4619+
"description": "Success",
4620+
"content": {
4621+
"application/json": {
4622+
"schema": {
4623+
"type": "array",
4624+
"items": {
4625+
"properties": {
4626+
"name": {
4627+
"type": "string",
4628+
"example": "March Newsletter"
4629+
},
4630+
"status": {
4631+
"type": "string",
4632+
"example": "sent",
4633+
"nullable": true
4634+
},
4635+
"date": {
4636+
"type": "string",
4637+
"format": "date",
4638+
"example": "2026-03-15",
4639+
"nullable": true
4640+
},
4641+
"open_rate": {
4642+
"type": "string",
4643+
"example": "42.50%"
4644+
},
4645+
"click_rate": {
4646+
"type": "string",
4647+
"example": "8.10%"
4648+
}
4649+
},
4650+
"type": "object"
4651+
}
4652+
}
4653+
}
4654+
}
4655+
},
4656+
"401": {
4657+
"description": "Not authenticated",
4658+
"content": {
4659+
"application/json": {
4660+
"schema": {
4661+
"$ref": "#/components/schemas/UnauthorizedResponse"
4662+
}
4663+
}
4664+
}
4665+
}
4666+
}
4667+
}
4668+
},
4669+
"/api/v2/analytics/dashboard/performance": {
4670+
"get": {
4671+
"tags": [
4672+
"analytics"
4673+
],
4674+
"summary": "Gets dashboard campaign performance statistics.",
4675+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns campaign performance metrics over time.",
4676+
"operationId": "5a81041f89c91c9e6630c14289696769",
4677+
"parameters": [
4678+
{
4679+
"name": "php-auth-pw",
4680+
"in": "header",
4681+
"description": "Session key obtained from login",
4682+
"required": true,
4683+
"schema": {
4684+
"type": "string"
4685+
}
4686+
}
4687+
],
4688+
"responses": {
4689+
"200": {
4690+
"description": "Success",
4691+
"content": {
4692+
"application/json": {
4693+
"schema": {
4694+
"type": "array",
4695+
"items": {
4696+
"properties": {
4697+
"date": {
4698+
"type": "string",
4699+
"format": "date",
4700+
"example": "2026-03-19"
4701+
},
4702+
"opens": {
4703+
"type": "integer",
4704+
"example": 234
4705+
},
4706+
"clicks": {
4707+
"type": "integer",
4708+
"example": 57
4709+
}
4710+
},
4711+
"type": "object"
4712+
}
4713+
}
4714+
}
4715+
}
4716+
},
4717+
"401": {
4718+
"description": "Not authenticated",
4719+
"content": {
4720+
"application/json": {
4721+
"schema": {
4722+
"$ref": "#/components/schemas/UnauthorizedResponse"
4723+
}
4724+
}
4725+
}
4726+
}
4727+
}
4728+
}
4729+
},
46554730
"/api/v2/t/open.gif": {
46564731
"get": {
46574732
"tags": [

0 commit comments

Comments
 (0)