up

Statistics

Get statistics, for instance, of how a campaign performed.

Get statistics

Work with statistics of a batch (a batch is a 'send' of a campaign). There are a number of different statistics you can get for a send. For instance (replace BATCHID with the batch-id of the send):

/statistics/batch/BATCHID/overview
/statistics/batch/BATCHID/click-targets
/statistics/batch/BATCHID/languages
/statistics/batch/BATCHID/clicks-over-time
/statistics/batch/BATCHID/views-over-time
/statistics/batch/BATCHID/devices
/statistics/batch/BATCHID/general
/statistics/batch/BATCHID/unsubscribes-over-time
/statistics/batch/BATCHID/complaints-over-time
/statistics/batch/BATCHID/batch-overview

This can definitely use a bit more thorough documentation. If you need assistance, please get in touch with us.

HTTP method: GET
http://api.sendcastle.com/v1/statistics/misc
cURL example
curl http://api.sendcastle.com/v1/statistics/misc
\ -H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json"
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":{
		"UNKNOWN_RETURN_OBJECT: 'statistics.'":{
		"id":"1",
		"xxx"
	}
}
Other constraints:
  • Identifier can be an integer, 'all' or one of the following: misc, batch
  • No additional parameters required, unless stated elsewhere
  • No extra security requirements
  • Requires read access
Create statistics

Work with statistics of a batch (a batch is a 'send' of a campaign). There are a number of different statistics you can get for a send. For instance (replace BATCHID with the batch-id of the send):

/statistics/batch/BATCHID/overview
/statistics/batch/BATCHID/click-targets
/statistics/batch/BATCHID/languages
/statistics/batch/BATCHID/clicks-over-time
/statistics/batch/BATCHID/views-over-time
/statistics/batch/BATCHID/devices
/statistics/batch/BATCHID/general
/statistics/batch/BATCHID/unsubscribes-over-time
/statistics/batch/BATCHID/complaints-over-time
/statistics/batch/BATCHID/batch-overview

This can definitely use a bit more thorough documentation. If you need assistance, please get in touch with us.

HTTP method: PUT
http://api.sendcastle.com/v1/statistics/[123]
cURL example
curl http://api.sendcastle.com/v1/statistics/[123] \
	-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json" \ -X PUT
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":{
		"id":"1"
	}
}
Other constraints:
  • Identifier should be an integer
  • Identifier should be UID
  • No additional parameters required, unless stated elsewhere
  • No extra security requirements
  • Requires create access
  • Requires administrator access
Change statistics

Work with statistics of a batch (a batch is a 'send' of a campaign). There are a number of different statistics you can get for a send. For instance (replace BATCHID with the batch-id of the send):

/statistics/batch/BATCHID/overview
/statistics/batch/BATCHID/click-targets
/statistics/batch/BATCHID/languages
/statistics/batch/BATCHID/clicks-over-time
/statistics/batch/BATCHID/views-over-time
/statistics/batch/BATCHID/devices
/statistics/batch/BATCHID/general
/statistics/batch/BATCHID/unsubscribes-over-time
/statistics/batch/BATCHID/complaints-over-time
/statistics/batch/BATCHID/batch-overview

This can definitely use a bit more thorough documentation. If you need assistance, please get in touch with us.

HTTP method: POST
http://api.sendcastle.com/v1/statistics/[123]
cURL example
curl http://api.sendcastle.com/v1/statistics/[123] \
	-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json" \ -X POST
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":true
}
Other constraints:
  • Identifier should be an integer
  • Identifier should be UID
  • No additional parameters required, unless stated elsewhere
  • No extra security requirements
  • Requires write access
  • VC_VRO
Delete statistics

Work with statistics of a batch (a batch is a 'send' of a campaign). There are a number of different statistics you can get for a send. For instance (replace BATCHID with the batch-id of the send):

/statistics/batch/BATCHID/overview
/statistics/batch/BATCHID/click-targets
/statistics/batch/BATCHID/languages
/statistics/batch/BATCHID/clicks-over-time
/statistics/batch/BATCHID/views-over-time
/statistics/batch/BATCHID/devices
/statistics/batch/BATCHID/general
/statistics/batch/BATCHID/unsubscribes-over-time
/statistics/batch/BATCHID/complaints-over-time
/statistics/batch/BATCHID/batch-overview

This can definitely use a bit more thorough documentation. If you need assistance, please get in touch with us.

HTTP method: DELETE
http://api.sendcastle.com/v1/statistics/[123]
cURL example
curl http://api.sendcastle.com/v1/statistics/[123] \
	-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json" \ -X DELETE
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":true
}
Other constraints:
  • Identifier should be an integer
  • Identifier should be UID
  • No additional parameters required, unless stated elsewhere
  • No extra security requirements
  • Requires delete access
  • Requires administrator access
Get brief aggregated results (statistics)

This gets a small subset of full statistics of a send. It's just a helper method for generating a quick overview of recent activity.

HTTP method: GET
http://api.sendcastle.com/v1/statistics/[xx]/misc/[yy]
cURL example
curl http://api.sendcastle.com/v1/statistics/[xx]/misc/[yy] \
	-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json"
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":{
		"UNKNOWN_RETURN_OBJECT: 'statistics.misc'":{
		"id":"1",
		"xxx"
	}
}
Other constraints:
  • Requires read access
Get batch results (statistics)

Get some statistics for a specific batch.

HTTP method: GET
http://api.sendcastle.com/v1/statistics/[xx]/batch/[yy]
cURL example
curl http://api.sendcastle.com/v1/statistics/[xx]/batch/[yy] \
	-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json"
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":{
		"UNKNOWN_RETURN_OBJECT: 'statistics.batch'":{
		"id":"1",
		"xxx"
	}
}
Other constraints:
  • Requires read access
get.statistics.browse (!)

No description yet.

HTTP method: GET
http://api.sendcastle.com/v1/statistics/[xx]/browse/[yy]
cURL example
curl http://api.sendcastle.com/v1/statistics/[xx]/browse/[yy] \
	-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json"
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":{
		"UNKNOWN_RETURN_OBJECT: 'statistics.browse'":{
		"id":"1",
		"xxx"
	}
}
Other constraints:
  • No additional parameters required, unless stated elsewhere
  • No extra security requirements
  • Requires read access
get.statistics.download (!)

No description yet.

HTTP method: GET
http://api.sendcastle.com/v1/statistics/[xx]/download/[yy]
cURL example
curl http://api.sendcastle.com/v1/statistics/[xx]/download/[yy] \
	-H "Authorization: Bearer YOUR_API_SECRET_HERE" \
-H "Content-Type: application/json"
Example of result
{
	"responseId":"50cef8fcaxxxx",
	"version":1,
	"success":true,
	"data":{
		"UNKNOWN_RETURN_OBJECT: 'statistics.download'":{
		"id":"1",
		"xxx"
	}
}
Other constraints:
  • No additional parameters required, unless stated elsewhere
  • No extra security requirements
  • Requires read access