Datasets:
davidfant
/
rapidapi-example-responses

Dataset card Data Studio Files Community
1
id
stringlengths
53
86
api_name
stringlengths
2
76
api_description
stringlengths
1
500
⌀
api_score
float64
0
10
⌀
endpoint_name
stringlengths
1
190
endpoint_description
stringlengths
0
500
response_status_code
int64
100
505
response_summary
stringlengths
1
68
⌀
response_json
stringlengths
6
50k
response_json_schema
stringlengths
14
150k
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/28c63bd2-e0e9-4589-9dde-383b73975c00/0/0
Altoviz
Invoicing and accounting APIs
null
GET_Customers_GetContacts
200
null
[{"isMain": true, "id": 0, "title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "displayName": ""}]
{"type": "array", "items": {"type": "object", "properties": {"isMain": {"type": "boolean", "description": "Indicates if the contact is the main third contact"}, "id": {"type": "integer", "description": "Contact ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "title": {"type": ["string", "null"]}, "lastName": {"type": ["string", "null"]}, "firstName": {"type": ["string", "null"]}, "email": {"type": ["string", "null"]}, "cellPhone": {"type": ["string", "null"]}, "phone": {"type": ["string", "null"]}, "companyName": {"type": ["string", "null"]}, "displayName": {"type": ["string", "null"]}}, "additionalProperties": false, "description": "Third contact"}}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/10a794ce-e9a3-44cd-8985-6c189c728ba2/0/0
Altoviz
Invoicing and accounting APIs
null
GET_Customers_Find
200
null
[{"id": 0, "title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "billingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "shippingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "companyInformations": {"siret": "", "vatNumber": ""}, "billingOptions": {"discount": {"type": "Percent", "value": 0}, "vatReverseCharge": true, "vendorReference": ""}, "type": "Company", "number": ""}]
{"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "description": "Customer ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "title": {"type": ["string", "null"], "description": "Title"}, "lastName": {"type": ["string", "null"], "description": "Last name"}, "firstName": {"type": ["string", "null"], "description": "First name"}, "email": {"type": ["string", "null"], "description": "Email"}, "cellPhone": {"type": ["string", "null"], "description": "Cell phone number"}, "phone": {"type": ["string", "null"], "description": "Phone number"}, "companyName": {"type": ["string", "null"], "description": "Company name"}, "billingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "companyInformations": {"type": "object", "properties": {"siret": {"type": ["string", "null"]}, "vatNumber": {"type": ["string", "null"]}}, "additionalProperties": false}, "billingOptions": {"type": "object", "properties": {"discount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "vatReverseCharge": {"type": "boolean", "description": "Indicates VAT should be included in sales"}, "vendorReference": {"type": ["string", "null"], "description": "Vendor reference. Used to be print on sales"}}, "additionalProperties": false, "description": "Billing options"}, "type": {"enum": ["Company", "Individual"], "type": "string"}, "number": {"type": ["string", "null"], "description": "Number"}}, "additionalProperties": false, "description": "Customer"}}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/10a794ce-e9a3-44cd-8985-6c189c728ba2/1/0
Altoviz
Invoicing and accounting APIs
null
GET_Customers_Find
404
null
{"type": "", "title": "", "status": 0, "detail": "", "instance": ""}
{"type": "object", "properties": {"type": {"type": ["string", "null"]}, "title": {"type": ["string", "null"]}, "status": {"type": ["integer", "null"], "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "detail": {"type": ["string", "null"]}, "instance": {"type": ["string", "null"]}}, "additionalProperties": {}}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/500fca04-f513-4d48-8de1-a715a2bc884e/0/0
Altoviz
Invoicing and accounting APIs
null
GET_Customers_Get
200
null
{"id": 0, "title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "billingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "shippingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "companyInformations": {"siret": "", "vatNumber": ""}, "billingOptions": {"discount": {"type": "Percent", "value": 0}, "vatReverseCharge": true, "vendorReference": ""}, "type": "Company", "number": ""}
{"type": "object", "properties": {"id": {"type": "integer", "description": "Customer ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "title": {"type": ["string", "null"], "description": "Title"}, "lastName": {"type": ["string", "null"], "description": "Last name"}, "firstName": {"type": ["string", "null"], "description": "First name"}, "email": {"type": ["string", "null"], "description": "Email"}, "cellPhone": {"type": ["string", "null"], "description": "Cell phone number"}, "phone": {"type": ["string", "null"], "description": "Phone number"}, "companyName": {"type": ["string", "null"], "description": "Company name"}, "billingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "companyInformations": {"type": "object", "properties": {"siret": {"type": ["string", "null"]}, "vatNumber": {"type": ["string", "null"]}}, "additionalProperties": false}, "billingOptions": {"type": "object", "properties": {"discount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "vatReverseCharge": {"type": "boolean", "description": "Indicates VAT should be included in sales"}, "vendorReference": {"type": ["string", "null"], "description": "Vendor reference. Used to be print on sales"}}, "additionalProperties": false, "description": "Billing options"}, "type": {"enum": ["Company", "Individual"], "type": "string"}, "number": {"type": ["string", "null"], "description": "Number"}}, "additionalProperties": false, "description": "Customer"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/6c752326-5c7e-4b3c-941d-d1306af23d4d/0/0
Altoviz
Invoicing and accounting APIs
null
GET_Customers_List
200
null
[{"id": 0, "title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "billingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "shippingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "companyInformations": {"siret": "", "vatNumber": ""}, "billingOptions": {"discount": {"type": "Percent", "value": 0}, "vatReverseCharge": true, "vendorReference": ""}, "type": "Company", "number": ""}]
{"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "description": "Customer ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "title": {"type": ["string", "null"], "description": "Title"}, "lastName": {"type": ["string", "null"], "description": "Last name"}, "firstName": {"type": ["string", "null"], "description": "First name"}, "email": {"type": ["string", "null"], "description": "Email"}, "cellPhone": {"type": ["string", "null"], "description": "Cell phone number"}, "phone": {"type": ["string", "null"], "description": "Phone number"}, "companyName": {"type": ["string", "null"], "description": "Company name"}, "billingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "companyInformations": {"type": "object", "properties": {"siret": {"type": ["string", "null"]}, "vatNumber": {"type": ["string", "null"]}}, "additionalProperties": false}, "billingOptions": {"type": "object", "properties": {"discount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "vatReverseCharge": {"type": "boolean", "description": "Indicates VAT should be included in sales"}, "vendorReference": {"type": ["string", "null"], "description": "Vendor reference. Used to be print on sales"}}, "additionalProperties": false, "description": "Billing options"}, "type": {"enum": ["Company", "Individual"], "type": "string"}, "number": {"type": ["string", "null"], "description": "Number"}}, "additionalProperties": false, "description": "Customer"}}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/1975023f-07fe-4916-b620-41f491359ddc/0/0
Altoviz
Invoicing and accounting APIs
null
POST_Customers_Post
200
null
{"id": 0, "title": "", "lastName": "", "firstName": "", "email": "", "cellPhone": "", "phone": "", "companyName": "", "billingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "shippingAddress": {"street": "", "zipcode": "", "city": "", "countryIso": "", "formattedAddress": "", "inlineAddress": ""}, "companyInformations": {"siret": "", "vatNumber": ""}, "billingOptions": {"discount": {"type": "Percent", "value": 0}, "vatReverseCharge": true, "vendorReference": ""}, "type": "Company", "number": ""}
{"type": "object", "properties": {"id": {"type": "integer", "description": "Customer ID", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "title": {"type": ["string", "null"], "description": "Title"}, "lastName": {"type": ["string", "null"], "description": "Last name"}, "firstName": {"type": ["string", "null"], "description": "First name"}, "email": {"type": ["string", "null"], "description": "Email"}, "cellPhone": {"type": ["string", "null"], "description": "Cell phone number"}, "phone": {"type": ["string", "null"], "description": "Phone number"}, "companyName": {"type": ["string", "null"], "description": "Company name"}, "billingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "shippingAddress": {"type": "object", "properties": {"street": {"type": ["string", "null"]}, "zipcode": {"type": ["string", "null"]}, "city": {"type": ["string", "null"]}, "countryIso": {"type": ["string", "null"]}, "formattedAddress": {"type": ["string", "null"]}, "inlineAddress": {"type": ["string", "null"]}}, "additionalProperties": false}, "companyInformations": {"type": "object", "properties": {"siret": {"type": ["string", "null"]}, "vatNumber": {"type": ["string", "null"]}}, "additionalProperties": false}, "billingOptions": {"type": "object", "properties": {"discount": {"type": "object", "properties": {"type": {"enum": ["Percent", "Fixed"], "type": "string"}, "value": {"type": "number", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}}, "additionalProperties": false}, "vatReverseCharge": {"type": "boolean", "description": "Indicates VAT should be included in sales"}, "vendorReference": {"type": ["string", "null"], "description": "Vendor reference. Used to be print on sales"}}, "additionalProperties": false, "description": "Billing options"}, "type": {"enum": ["Company", "Individual"], "type": "string"}, "number": {"type": ["string", "null"], "description": "Number"}}, "additionalProperties": false, "description": "Customer"}
0845db66-b59a-4aa5-ba9c-7ec17ae1bc54/1975023f-07fe-4916-b620-41f491359ddc/1/0
Altoviz
Invoicing and accounting APIs
null
POST_Customers_Post
400
null
{"message": "", "errors": []}
{"type": "object", "properties": {"message": {"type": ["string", "null"], "description": "Error message"}, "errors": {"type": ["array", "null"], "items": {"type": "string"}, "description": "List of error messages"}}, "additionalProperties": false, "description": "Error"}
498a3db2-4212-4fd4-961a-9f12e4a0b49c/0307fe11-0ab6-47b0-8c4d-35d530136dca/0/0
BinApi24
BinApi24 is an API service for looking up credit and debit card metadata. You can use it for credit card validation to increase fraud detection accuracy and to help merchants analyze and assess their payment card transactions. More–and more accurate–information can lead to more efficient operations
8.2
Get BIN/INN metadata
This endpoint will return back BIN/INN metadata
200
New Example
{"key1": "value", "key2": "value"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]}
515ee2ea-03e7-427a-89cf-2c03db78df7e/f45d1198-29e7-42e2-8438-078f3112cd68/1/0
testnt
API
null
listVersionsv1">
200
null
{"versions": [{"id": "v2.0", "links": [{"href": "http://127.0.0.1:8774/v2/", "rel": "self"}], "status": "CURRENT", "updated": "2011-01-21T11:33:21Z"}, {"id": "v3.0", "links": [{"href": "http://127.0.0.1:8774/v3/", "rel": "self"}], "status": "EXPERIMENTAL", "updated": "2013-07-23T11:33:21Z"}]}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"versions": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "links": {"type": "array", "items": {"type": "object", "properties": {"href": {"type": "string"}, "rel": {"type": "string"}}, "required": ["href", "rel"]}}, "status": {"type": "string"}, "updated": {"type": "string"}}, "required": ["id", "links", "status", "updated"]}}}, "required": ["versions"]}
515ee2ea-03e7-427a-89cf-2c03db78df7e/a182091a-282c-4698-8f6c-74e01ac31e20/0/0
testnt
API
null
getVersionDetailsv2
203
null
{"version": {"id": "v2.0", "links": [{"href": "http://23.253.228.211:8774/v2/", "rel": "self"}, {"href": "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf", "rel": "describedby", "type": "application/pdf"}, {"href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", "rel": "describedby", "type": "application/vnd.sun.wadl+xml"}], "media-types": [{"base": "application/xml", "type": "application/vnd.openstack.compute+xml;version=2"}, {"base": "application/json", "type": "application/vnd.openstack.compute+json;version=2"}], "status": "CURRENT", "updated": "2011-01-21T11:33:21Z"}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"version": {"type": "object", "properties": {"id": {"type": "string"}, "links": {"type": "array", "items": {"type": "object", "properties": {"href": {"type": "string"}, "rel": {"type": "string"}, "type": {"type": "string"}}, "required": ["href", "rel"]}}, "media-types": {"type": "array", "items": {"type": "object", "properties": {"base": {"type": "string"}, "type": {"type": "string"}}, "required": ["base", "type"]}}, "status": {"type": "string"}, "updated": {"type": "string"}}, "required": ["id", "links", "media-types", "status", "updated"]}}, "required": ["version"]}
515ee2ea-03e7-427a-89cf-2c03db78df7e/a182091a-282c-4698-8f6c-74e01ac31e20/1/0
testnt
API
null
getVersionDetailsv2
200
null
{"version": {"id": "v2.0", "links": [{"href": "http://127.0.0.1:8774/v2/", "rel": "self"}, {"href": "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf", "rel": "describedby", "type": "application/pdf"}, {"href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", "rel": "describedby", "type": "application/vnd.sun.wadl+xml"}, {"href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", "rel": "describedby", "type": "application/vnd.sun.wadl+xml"}], "media-types": [{"base": "application/xml", "type": "application/vnd.openstack.compute+xml;version=2"}, {"base": "application/json", "type": "application/vnd.openstack.compute+json;version=2"}], "status": "CURRENT", "updated": "2011-01-21T11:33:21Z"}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"version": {"type": "object", "properties": {"id": {"type": "string"}, "links": {"type": "array", "items": {"type": "object", "properties": {"href": {"type": "string"}, "rel": {"type": "string"}, "type": {"type": "string"}}, "required": ["href", "rel"]}}, "media-types": {"type": "array", "items": {"type": "object", "properties": {"base": {"type": "string"}, "type": {"type": "string"}}, "required": ["base", "type"]}}, "status": {"type": "string"}, "updated": {"type": "string"}}, "required": ["id", "links", "media-types", "status", "updated"]}}, "required": ["version"]}
51c0d6ad-094b-4357-ab2b-b2b5628b0b76/720d78cf-de8b-4d58-bbb6-afe977c82c25/0/0
QR Tracker Client API
QR Tracker Ticket client api to create end user validation apps
null
QR Tracker Ticket Client API
QR Client API allows developers to create new client side apps to validate QR Tracker Tickets
200
New Example
{"statusmsg": "", "qrtyp": "", "picurl": "", "status": "", "info": "", "comment": "", "cemail": "", "accessed": "", "accessedmax": "", "qrsecure": ""}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"statusmsg": {"type": "string"}, "qrtyp": {"type": "string"}, "picurl": {"type": "string"}, "status": {"type": "string"}, "info": {"type": "string"}, "comment": {"type": "string"}, "cemail": {"type": "string"}, "accessed": {"type": "string"}, "accessedmax": {"type": "string"}, "qrsecure": {"type": "string"}}, "required": ["accessed", "accessedmax", "cemail", "comment", "info", "picurl", "qrsecure", "qrtyp", "status", "statusmsg"]}
4188b868-d0fb-41ab-9371-616114d5285b/0da79122-b9e4-4cea-aeb7-7205f1cc648e/0/0
Face Detection with Age and Gender Estimation
Very easy face detection api that detect all faces in a photo with gender & age estimation
null
Detect
Detect all person's faces in a photo with their age & gender (estimation), in one simple POST request with only one parameter that is photo where to upload the your image base64 encoded see our home page for handling: https://faceapi.hirak.site, then you'll retrieve the coordination's of faces's boxes & the rest as json array/object
200
Response
[{"detection": {"_imageDims": {"_width": 960, "_height": 1200}, "_score": 0.8972481489181519, "_classScore": 0.8972481489181519, "_className": "", "_box": {"_x": 350.4277105564024, "_y": 135.09405255317688, "_width": 167.57862519054882, "_height": 197.6879060268402}}, "gender": "male", "genderProbability": 0.983290433883667, "age": 18.90046501159668}]
{"$schema": "http://json-schema.org/schema#", "type": "array", "items": {"type": "object", "properties": {"detection": {"type": "object", "properties": {"_imageDims": {"type": "object", "properties": {"_width": {"type": "integer"}, "_height": {"type": "integer"}}, "required": ["_height", "_width"]}, "_score": {"type": "number"}, "_classScore": {"type": "number"}, "_className": {"type": "string"}, "_box": {"type": "object", "properties": {"_x": {"type": "number"}, "_y": {"type": "number"}, "_width": {"type": "number"}, "_height": {"type": "number"}}, "required": ["_height", "_width", "_x", "_y"]}}, "required": ["_box", "_className", "_classScore", "_imageDims", "_score"]}, "gender": {"type": "string"}, "genderProbability": {"type": "number"}, "age": {"type": "number"}}, "required": ["age", "detection", "gender", "genderProbability"]}}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/1d9f30e3-3958-4f2f-9669-d3fe11155e33/0/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getJob
Get the status of a queued job, including its status and result if available.
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/1d9f30e3-3958-4f2f-9669-d3fe11155e33/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getJob
Get the status of a queued job, including its status and result if available.
200
null
{"id": "65d397fc-b8b1-4e07-9437-026253db663a", "data": {}, "status": "", "error": "", "userId": "65d397fc-b8b1-4e07-9437-026253db663a"}
{"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "data": {"type": "object"}, "status": {"type": "string"}, "error": {"type": "string"}, "userId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}}}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/1d9f30e3-3958-4f2f-9669-d3fe11155e33/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getJob
Get the status of a queued job, including its status and result if available.
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/1d9f30e3-3958-4f2f-9669-d3fe11155e33/3/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getJob
Get the status of a queued job, including its status and result if available.
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/a5106842-ffdf-4b3e-82f4-ac5d0bc5b1fb/0/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
createVisualization
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/a5106842-ffdf-4b3e-82f4-ac5d0bc5b1fb/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
createVisualization
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/312ebdb3-be57-4f6f-a21b-d7bf42eb8e47/0/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
duplicateTemplate
Duplicate a report template by its ID
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/312ebdb3-be57-4f6f-a21b-d7bf42eb8e47/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
duplicateTemplate
Duplicate a report template by its ID
200
null
{"id": "65d397fc-b8b1-4e07-9437-026253db663a", "title": "", "htmlContent": "", "platform": "qlikSense", "pageWidth": 0, "pageHeight": 0}
{"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "title": {"type": "string", "maximum": 100}, "htmlContent": {"type": "string", "maximum": 500000}, "platform": {"type": "string", "enum": ["qlikSense", "tableau"]}, "pageWidth": {"type": "integer"}, "pageHeight": {"type": "integer"}}}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/312ebdb3-be57-4f6f-a21b-d7bf42eb8e47/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
duplicateTemplate
Duplicate a report template by its ID
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/312ebdb3-be57-4f6f-a21b-d7bf42eb8e47/3/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
duplicateTemplate
Duplicate a report template by its ID
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/660f0e14-b62d-40ef-943e-458b9c19e1d4/0/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
createReportTask
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/660f0e14-b62d-40ef-943e-458b9c19e1d4/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
createReportTask
200
null
{"id": "65d397fc-b8b1-4e07-9437-026253db663a", "title": "", "templateId": "1392343e-c2b1-4e67-84b0-4afd219c57fe", "startOn": "", "endOn": "", "frequency": "Monthly", "every": "", "at": "", "enabled": true, "filterSets": [{"id": "", "title": ""}], "filterCycleId": "65d397fc-b8b1-4e07-9437-026253db663a", "nextRunAt": "", "error": "", "averageTimeToGenerate": 0, "customSelection": [{"fieldName": "", "fieldDef": "", "fieldValues": [{"text": "", "number": ""}]}], "variables": [{"name": "", "value": ""}], "meta": {}, "dataPlatformWaitTime": 0, "email": "pdf", "groupsToShareWith": [{"groupId": "1392343e-c2b1-4e67-84b0-4afd219c57fe"}], "tags": [{"id": "1392343e-c2b1-4e67-84b0-4afd219c57fe", "name": ""}], "usersToShareWith": [{"userId": "1392343e-c2b1-4e67-84b0-4afd219c57fe", "email": "[email protected]"}]}
{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "title": {"type": "string", "description": "Title of the report task", "maximum": 500}, "templateId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "startOn": {"type": "string", "description": "Datetime in UTC when report task's schedule will start", "format": "date-time", "maximum": 100}, "endOn": {"type": "string", "description": "Datetime in UTC when report task schedule will end", "format": "date-time", "maximum": 100}, "frequency": {"type": "string", "description": "Describes the frequency of the report task's schedule", "maximum": 100, "enum": ["Monthly", "Once - now", "Once - Scheduled", "Annually", "Daily", "Weekly"]}, "every": {"type": "string", "description": "The interval of the report task's schedule", "maximum": 100}, "at": {"type": "string", "description": "Datetime in UTC when the report task will execute", "format": "date-time", "maximum": 100}, "enabled": {"description": "Denotes whether the report task will go into the report processing queue", "type": "boolean"}, "filterSets": {"description": "Array of objects denoting filter sets to apply to the report task", "type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "title": {"type": "string"}}}}, "filterCycleId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "nextRunAt": {"type": "string", "description": "Calculated datetime in UTC when the report task will run next, if applicable", "format": "date-time", "maximum": 200}, "error": {"type": "string", "description": "The error object from the last report task execution, if applicable", "maximum": 200}, "averageTimeToGenerate": {"type": "number", "description": "The average time to run the report task, in minutes", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "customSelection": {"type": "array", "items": {"type": "object", "properties": {"fieldName": {"type": "string", "description": "The label of the field. Used for display in certain scenarios."}, "fieldDef": {"type": "string", "description": "The definition of the field."}, "fieldValues": {"type": "array", "items": {"type": "object", "properties": {"text": {"type": "string"}, "number": {"type": "string"}}}}}}, "description": "Custom filters to apply. This field will be updated entirely if provided"}, "variables": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "value": {"type": "string"}}}}, "meta": {"type": "object", "additionalProperties": {"type": "string"}}, "dataPlatformWaitTime": {"type": "number", "format": "double", "description": "The time spent waiting on data platform responses during the last report task execution, in minutes", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "email": {"type": "string", "description": "Denotes whether the generated report should be emailed to its users or groups after a successful run", "maximum": 100, "enum": ["pdf", "pptx", "xlsx", "csv"]}, "groupsToShareWith": {"description": "Groups to share the published report with. This field will be updated entirely if provided", "type": "array", "items": {"type": "object", "properties": {"groupId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}}}}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "name": {"type": "string"}}}}}}, {"type": "object", "properties": {"usersToShareWith": {"description": "Users to share the published report with. This field will be updated entirely if provided", "type": "array", "items": {"type": "object", "properties": {"userId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "email": {"type": "string"}}}}}}]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/660f0e14-b62d-40ef-943e-458b9c19e1d4/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
createReportTask
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/660f0e14-b62d-40ef-943e-458b9c19e1d4/3/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
createReportTask
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/44a62b8d-5801-4395-b8c2-9fdd46f30dad/0/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getBaseTemplates
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/44a62b8d-5801-4395-b8c2-9fdd46f30dad/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getBaseTemplates
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/44a62b8d-5801-4395-b8c2-9fdd46f30dad/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getBaseTemplates
200
null
{"baseTemplates": [{"id": "65d397fc-b8b1-4e07-9437-026253db663a", "title": "", "htmlContent": "", "platform": "qlikSense", "pageWidth": 0, "pageHeight": 0}], "totalPages": 2}
{"type": "object", "properties": {"baseTemplates": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "title": {"type": "string", "maximum": 100}, "htmlContent": {"type": "string", "maximum": 500000}, "platform": {"type": "string", "enum": ["qlikSense", "tableau"]}, "pageWidth": {"type": "integer"}, "pageHeight": {"type": "integer"}}}}, "totalPages": {"type": "integer"}}}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/44a62b8d-5801-4395-b8c2-9fdd46f30dad/3/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getBaseTemplates
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/6de01b76-37c4-41d0-ad79-f0e118615436/0/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
duplicateBaseTemplate
Duplicate a base template by its ID
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/6de01b76-37c4-41d0-ad79-f0e118615436/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
duplicateBaseTemplate
Duplicate a base template by its ID
200
null
{"id": "65d397fc-b8b1-4e07-9437-026253db663a", "title": "", "htmlContent": "", "platform": "qlikSense", "pageWidth": 0, "pageHeight": 0}
{"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "title": {"type": "string", "maximum": 100}, "htmlContent": {"type": "string", "maximum": 500000}, "platform": {"type": "string", "enum": ["qlikSense", "tableau"]}, "pageWidth": {"type": "integer"}, "pageHeight": {"type": "integer"}}}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/6de01b76-37c4-41d0-ad79-f0e118615436/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
duplicateBaseTemplate
Duplicate a base template by its ID
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/6de01b76-37c4-41d0-ad79-f0e118615436/3/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
duplicateBaseTemplate
Duplicate a base template by its ID
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/b245b7eb-f4b0-49c2-9675-4bb7349fbfb3/0/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
updateFilterCycle
200
null
{"id": "65d397fc-b8b1-4e07-9437-026253db663a", "title": "", "templateId": "1392343e-c2b1-4e67-84b0-4afd219c57fe", "startOn": "", "endOn": "", "frequency": "Monthly", "every": "", "at": "", "enabled": true, "filterSets": [{"id": "", "title": ""}], "filterCycleId": "65d397fc-b8b1-4e07-9437-026253db663a", "nextRunAt": "", "error": "", "averageTimeToGenerate": 0, "customSelection": [{"fieldName": "", "fieldDef": "", "fieldValues": [{"text": "", "number": ""}]}], "variables": [{"name": "", "value": ""}], "meta": {}, "dataPlatformWaitTime": 0, "email": "pdf", "groupsToShareWith": [{"groupId": "1392343e-c2b1-4e67-84b0-4afd219c57fe"}], "tags": [{"id": "1392343e-c2b1-4e67-84b0-4afd219c57fe", "name": ""}], "fieldInfo": {"fieldId": "", "fieldName": "", "fieldDef": ""}, "fieldValues": [{"name": "", "text": "", "number": 0}], "connectionId": "", "selectAll": true, "autotag": true}
{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "title": {"type": "string", "description": "Title of the report task", "maximum": 500}, "templateId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "startOn": {"type": "string", "description": "Datetime in UTC when report task's schedule will start", "format": "date-time", "maximum": 100}, "endOn": {"type": "string", "description": "Datetime in UTC when report task schedule will end", "format": "date-time", "maximum": 100}, "frequency": {"type": "string", "description": "Describes the frequency of the report task's schedule", "maximum": 100, "enum": ["Monthly", "Once - now", "Once - Scheduled", "Annually", "Daily", "Weekly"]}, "every": {"type": "string", "description": "The interval of the report task's schedule", "maximum": 100}, "at": {"type": "string", "description": "Datetime in UTC when the report task will execute", "format": "date-time", "maximum": 100}, "enabled": {"description": "Denotes whether the report task will go into the report processing queue", "type": "boolean"}, "filterSets": {"description": "Array of objects denoting filter sets to apply to the report task", "type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "title": {"type": "string"}}}}, "filterCycleId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "nextRunAt": {"type": "string", "description": "Calculated datetime in UTC when the report task will run next, if applicable", "format": "date-time", "maximum": 200}, "error": {"type": "string", "description": "The error object from the last report task execution, if applicable", "maximum": 200}, "averageTimeToGenerate": {"type": "number", "description": "The average time to run the report task, in minutes", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "customSelection": {"type": "array", "items": {"type": "object", "properties": {"fieldName": {"type": "string", "description": "The label of the field. Used for display in certain scenarios."}, "fieldDef": {"type": "string", "description": "The definition of the field."}, "fieldValues": {"type": "array", "items": {"type": "object", "properties": {"text": {"type": "string"}, "number": {"type": "string"}}}}}}, "description": "Custom filters to apply. This field will be updated entirely if provided"}, "variables": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "value": {"type": "string"}}}}, "meta": {"type": "object", "additionalProperties": {"type": "string"}}, "dataPlatformWaitTime": {"type": "number", "format": "double", "description": "The time spent waiting on data platform responses during the last report task execution, in minutes", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "email": {"type": "string", "description": "Denotes whether the generated report should be emailed to its users or groups after a successful run", "maximum": 100, "enum": ["pdf", "pptx", "xlsx", "csv"]}, "groupsToShareWith": {"description": "Groups to share the published report with. This field will be updated entirely if provided", "type": "array", "items": {"type": "object", "properties": {"groupId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}}}}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "name": {"type": "string"}}}}}}, {"type": "object", "properties": {"fieldInfo": {"type": "object", "properties": {"fieldId": {"type": "string"}, "fieldName": {"type": "string"}, "fieldDef": {"type": "string"}}}, "fieldValues": {"description": "This field will be updated entirely if provided and will result in removing any existing report tasks associated with the filter cycle.", "type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "text": {"type": "string"}, "number": {"type": "number"}}}}, "connectionId": {"type": "string"}, "selectAll": {"type": "boolean"}, "autotag": {"type": "boolean"}}}]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/b245b7eb-f4b0-49c2-9675-4bb7349fbfb3/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
updateFilterCycle
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/b245b7eb-f4b0-49c2-9675-4bb7349fbfb3/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
updateFilterCycle
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/b245b7eb-f4b0-49c2-9675-4bb7349fbfb3/3/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
updateFilterCycle
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/a42cbdfa-a7f0-494f-8808-ba8b8162c2f3/0/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
deleteFilterCycle
200
null
{"id": "65d397fc-b8b1-4e07-9437-026253db663a", "title": "", "templateId": "1392343e-c2b1-4e67-84b0-4afd219c57fe", "startOn": "", "endOn": "", "frequency": "Monthly", "every": "", "at": "", "enabled": true, "filterSets": [{"id": "", "title": ""}], "filterCycleId": "65d397fc-b8b1-4e07-9437-026253db663a", "nextRunAt": "", "error": "", "averageTimeToGenerate": 0, "customSelection": [{"fieldName": "", "fieldDef": "", "fieldValues": [{"text": "", "number": ""}]}], "variables": [{"name": "", "value": ""}], "meta": {}, "dataPlatformWaitTime": 0, "email": "pdf", "groupsToShareWith": [{"groupId": "1392343e-c2b1-4e67-84b0-4afd219c57fe"}], "tags": [{"id": "1392343e-c2b1-4e67-84b0-4afd219c57fe", "name": ""}], "fieldInfo": {"fieldId": "", "fieldName": "", "fieldDef": ""}, "fieldValues": [{"name": "", "text": "", "number": 0}], "connectionId": "", "selectAll": true, "autotag": true}
{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "title": {"type": "string", "description": "Title of the report task", "maximum": 500}, "templateId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "startOn": {"type": "string", "description": "Datetime in UTC when report task's schedule will start", "format": "date-time", "maximum": 100}, "endOn": {"type": "string", "description": "Datetime in UTC when report task schedule will end", "format": "date-time", "maximum": 100}, "frequency": {"type": "string", "description": "Describes the frequency of the report task's schedule", "maximum": 100, "enum": ["Monthly", "Once - now", "Once - Scheduled", "Annually", "Daily", "Weekly"]}, "every": {"type": "string", "description": "The interval of the report task's schedule", "maximum": 100}, "at": {"type": "string", "description": "Datetime in UTC when the report task will execute", "format": "date-time", "maximum": 100}, "enabled": {"description": "Denotes whether the report task will go into the report processing queue", "type": "boolean"}, "filterSets": {"description": "Array of objects denoting filter sets to apply to the report task", "type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "title": {"type": "string"}}}}, "filterCycleId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "nextRunAt": {"type": "string", "description": "Calculated datetime in UTC when the report task will run next, if applicable", "format": "date-time", "maximum": 200}, "error": {"type": "string", "description": "The error object from the last report task execution, if applicable", "maximum": 200}, "averageTimeToGenerate": {"type": "number", "description": "The average time to run the report task, in minutes", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "customSelection": {"type": "array", "items": {"type": "object", "properties": {"fieldName": {"type": "string", "description": "The label of the field. Used for display in certain scenarios."}, "fieldDef": {"type": "string", "description": "The definition of the field."}, "fieldValues": {"type": "array", "items": {"type": "object", "properties": {"text": {"type": "string"}, "number": {"type": "string"}}}}}}, "description": "Custom filters to apply. This field will be updated entirely if provided"}, "variables": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "value": {"type": "string"}}}}, "meta": {"type": "object", "additionalProperties": {"type": "string"}}, "dataPlatformWaitTime": {"type": "number", "format": "double", "description": "The time spent waiting on data platform responses during the last report task execution, in minutes", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "email": {"type": "string", "description": "Denotes whether the generated report should be emailed to its users or groups after a successful run", "maximum": 100, "enum": ["pdf", "pptx", "xlsx", "csv"]}, "groupsToShareWith": {"description": "Groups to share the published report with. This field will be updated entirely if provided", "type": "array", "items": {"type": "object", "properties": {"groupId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}}}}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "name": {"type": "string"}}}}}}, {"type": "object", "properties": {"fieldInfo": {"type": "object", "properties": {"fieldId": {"type": "string"}, "fieldName": {"type": "string"}, "fieldDef": {"type": "string"}}}, "fieldValues": {"description": "This field will be updated entirely if provided and will result in removing any existing report tasks associated with the filter cycle.", "type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "text": {"type": "string"}, "number": {"type": "number"}}}}, "connectionId": {"type": "string"}, "selectAll": {"type": "boolean"}, "autotag": {"type": "boolean"}}}]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/a42cbdfa-a7f0-494f-8808-ba8b8162c2f3/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
deleteFilterCycle
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/a42cbdfa-a7f0-494f-8808-ba8b8162c2f3/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
deleteFilterCycle
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/a42cbdfa-a7f0-494f-8808-ba8b8162c2f3/3/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
deleteFilterCycle
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/6aa6ec73-b4d4-48ad-89aa-753773a45a73/0/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
renderReport
200
null
{"id": "65d397fc-b8b1-4e07-9437-026253db663a", "data": {}, "status": "", "error": "", "userId": "65d397fc-b8b1-4e07-9437-026253db663a"}
{"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "data": {"type": "object"}, "status": {"type": "string"}, "error": {"type": "string"}, "userId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}}}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/6aa6ec73-b4d4-48ad-89aa-753773a45a73/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
renderReport
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/6aa6ec73-b4d4-48ad-89aa-753773a45a73/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
renderReport
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/6aa6ec73-b4d4-48ad-89aa-753773a45a73/3/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
renderReport
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/aebf47f7-c830-4cb0-8ad6-d6ff3ddedafe/0/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getReports
200
null
{"reports": [{"reportId": "65d397fc-b8b1-4e07-9437-026253db663a", "id": "65d397fc-b8b1-4e07-9437-026253db663a", "createdAt": "", "title": "", "authorId": "65d397fc-b8b1-4e07-9437-026253db663a", "firstName": "", "lastName": "", "thumbnailPath": ""}], "totalPages": 2}
{"type": "object", "properties": {"reports": {"type": "array", "items": {"type": "object", "properties": {"reportId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "createdAt": {"type": "string", "description": "Datetime in UTC when the report was published", "format": "date-time", "maximum": 100}, "title": {"type": "string", "description": "Title of the report task", "maximum": 500}, "authorId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "firstName": {"type": "string", "description": "The given name of the author of the report"}, "lastName": {"type": "string", "description": "The surname of the author of the report"}, "thumbnailPath": {"type": "string", "description": "The relative path to the thumbnail of the report"}}}}, "totalPages": {"type": "integer"}}}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/aebf47f7-c830-4cb0-8ad6-d6ff3ddedafe/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getReports
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/aebf47f7-c830-4cb0-8ad6-d6ff3ddedafe/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getReports
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/aebf47f7-c830-4cb0-8ad6-d6ff3ddedafe/3/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getReports
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/e21de2ca-63c0-490c-a74c-2c5df9d8b722/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
exportTemplate
Export a report template to a .CRPT file
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/e21de2ca-63c0-490c-a74c-2c5df9d8b722/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
exportTemplate
Export a report template to a .CRPT file
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/e21de2ca-63c0-490c-a74c-2c5df9d8b722/3/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
exportTemplate
Export a report template to a .CRPT file
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/b767e8d4-cb26-4065-ac7c-976c0e24b755/0/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getReport
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/b767e8d4-cb26-4065-ac7c-976c0e24b755/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getReport
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/b767e8d4-cb26-4065-ac7c-976c0e24b755/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getReport
200
null
{"reportId": "65d397fc-b8b1-4e07-9437-026253db663a", "id": "65d397fc-b8b1-4e07-9437-026253db663a", "createdAt": "", "title": "", "authorId": "65d397fc-b8b1-4e07-9437-026253db663a", "firstName": "", "lastName": "", "thumbnailPath": ""}
{"type": "object", "properties": {"reportId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "createdAt": {"type": "string", "description": "Datetime in UTC when the report was published", "format": "date-time", "maximum": 100}, "title": {"type": "string", "description": "Title of the report task", "maximum": 500}, "authorId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "firstName": {"type": "string", "description": "The given name of the author of the report"}, "lastName": {"type": "string", "description": "The surname of the author of the report"}, "thumbnailPath": {"type": "string", "description": "The relative path to the thumbnail of the report"}}}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/b767e8d4-cb26-4065-ac7c-976c0e24b755/3/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getReport
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/5472ccac-1b4e-4e40-a5f2-692e320f24d6/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
deleteReportTask
Delete a report task by its ID
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/5472ccac-1b4e-4e40-a5f2-692e320f24d6/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
deleteReportTask
Delete a report task by its ID
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/5472ccac-1b4e-4e40-a5f2-692e320f24d6/3/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
deleteReportTask
Delete a report task by its ID
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/a8b94c00-52ca-4fe3-970b-cca35cf2f7b9/0/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getReportTask
Read a report task by its ID
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/a8b94c00-52ca-4fe3-970b-cca35cf2f7b9/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getReportTask
Read a report task by its ID
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/a8b94c00-52ca-4fe3-970b-cca35cf2f7b9/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getReportTask
Read a report task by its ID
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/a8b94c00-52ca-4fe3-970b-cca35cf2f7b9/3/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getReportTask
Read a report task by its ID
200
null
{"id": "65d397fc-b8b1-4e07-9437-026253db663a", "title": "", "templateId": "1392343e-c2b1-4e67-84b0-4afd219c57fe", "startOn": "", "endOn": "", "frequency": "Monthly", "every": "", "at": "", "enabled": true, "filterSets": [{"id": "", "title": ""}], "filterCycleId": "65d397fc-b8b1-4e07-9437-026253db663a", "nextRunAt": "", "error": "", "averageTimeToGenerate": 0, "customSelection": [{"fieldName": "", "fieldDef": "", "fieldValues": [{"text": "", "number": ""}]}], "variables": [{"name": "", "value": ""}], "meta": {}, "dataPlatformWaitTime": 0, "email": "pdf", "groupsToShareWith": [{"groupId": "1392343e-c2b1-4e67-84b0-4afd219c57fe"}], "tags": [{"id": "1392343e-c2b1-4e67-84b0-4afd219c57fe", "name": ""}], "usersToShareWith": [{"userId": "1392343e-c2b1-4e67-84b0-4afd219c57fe", "email": "[email protected]"}]}
{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "title": {"type": "string", "description": "Title of the report task", "maximum": 500}, "templateId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "startOn": {"type": "string", "description": "Datetime in UTC when report task's schedule will start", "format": "date-time", "maximum": 100}, "endOn": {"type": "string", "description": "Datetime in UTC when report task schedule will end", "format": "date-time", "maximum": 100}, "frequency": {"type": "string", "description": "Describes the frequency of the report task's schedule", "maximum": 100, "enum": ["Monthly", "Once - now", "Once - Scheduled", "Annually", "Daily", "Weekly"]}, "every": {"type": "string", "description": "The interval of the report task's schedule", "maximum": 100}, "at": {"type": "string", "description": "Datetime in UTC when the report task will execute", "format": "date-time", "maximum": 100}, "enabled": {"description": "Denotes whether the report task will go into the report processing queue", "type": "boolean"}, "filterSets": {"description": "Array of objects denoting filter sets to apply to the report task", "type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "title": {"type": "string"}}}}, "filterCycleId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "nextRunAt": {"type": "string", "description": "Calculated datetime in UTC when the report task will run next, if applicable", "format": "date-time", "maximum": 200}, "error": {"type": "string", "description": "The error object from the last report task execution, if applicable", "maximum": 200}, "averageTimeToGenerate": {"type": "number", "description": "The average time to run the report task, in minutes", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "customSelection": {"type": "array", "items": {"type": "object", "properties": {"fieldName": {"type": "string", "description": "The label of the field. Used for display in certain scenarios."}, "fieldDef": {"type": "string", "description": "The definition of the field."}, "fieldValues": {"type": "array", "items": {"type": "object", "properties": {"text": {"type": "string"}, "number": {"type": "string"}}}}}}, "description": "Custom filters to apply. This field will be updated entirely if provided"}, "variables": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "value": {"type": "string"}}}}, "meta": {"type": "object", "additionalProperties": {"type": "string"}}, "dataPlatformWaitTime": {"type": "number", "format": "double", "description": "The time spent waiting on data platform responses during the last report task execution, in minutes", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "email": {"type": "string", "description": "Denotes whether the generated report should be emailed to its users or groups after a successful run", "maximum": 100, "enum": ["pdf", "pptx", "xlsx", "csv"]}, "groupsToShareWith": {"description": "Groups to share the published report with. This field will be updated entirely if provided", "type": "array", "items": {"type": "object", "properties": {"groupId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}}}}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "name": {"type": "string"}}}}}}, {"type": "object", "properties": {"usersToShareWith": {"description": "Users to share the published report with. This field will be updated entirely if provided", "type": "array", "items": {"type": "object", "properties": {"userId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "email": {"type": "string"}}}}}}]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/09ee42ea-8f39-4ab4-9564-e7525f5528f8/0/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
importTemplate
Imports an exported .CRPT file
200
null
{"id": "65d397fc-b8b1-4e07-9437-026253db663a", "title": "", "htmlContent": "", "platform": "qlikSense", "pageWidth": 0, "pageHeight": 0}
{"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "title": {"type": "string", "maximum": 100}, "htmlContent": {"type": "string", "maximum": 500000}, "platform": {"type": "string", "enum": ["qlikSense", "tableau"]}, "pageWidth": {"type": "integer"}, "pageHeight": {"type": "integer"}}}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/09ee42ea-8f39-4ab4-9564-e7525f5528f8/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
importTemplate
Imports an exported .CRPT file
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/09ee42ea-8f39-4ab4-9564-e7525f5528f8/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
importTemplate
Imports an exported .CRPT file
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/09ee42ea-8f39-4ab4-9564-e7525f5528f8/3/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
importTemplate
Imports an exported .CRPT file
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/749fbbab-6c10-4f56-a1c4-0beeb734397e/0/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
deleteTemplate
Delete a report template by its ID
200
null
{"id": "65d397fc-b8b1-4e07-9437-026253db663a", "title": "", "htmlContent": "", "platform": "qlikSense", "pageWidth": 0, "pageHeight": 0}
{"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "title": {"type": "string", "maximum": 100}, "htmlContent": {"type": "string", "maximum": 500000}, "platform": {"type": "string", "enum": ["qlikSense", "tableau"]}, "pageWidth": {"type": "integer"}, "pageHeight": {"type": "integer"}}}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/749fbbab-6c10-4f56-a1c4-0beeb734397e/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
deleteTemplate
Delete a report template by its ID
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/749fbbab-6c10-4f56-a1c4-0beeb734397e/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
deleteTemplate
Delete a report template by its ID
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/749fbbab-6c10-4f56-a1c4-0beeb734397e/3/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
deleteTemplate
Delete a report template by its ID
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/0355504a-6475-4340-9363-55b7274f814b/0/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
createFilterCycle
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/0355504a-6475-4340-9363-55b7274f814b/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
createFilterCycle
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/0355504a-6475-4340-9363-55b7274f814b/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
createFilterCycle
200
null
{"id": "65d397fc-b8b1-4e07-9437-026253db663a", "title": "", "templateId": "1392343e-c2b1-4e67-84b0-4afd219c57fe", "startOn": "", "endOn": "", "frequency": "Monthly", "every": "", "at": "", "enabled": true, "filterSets": [{"id": "", "title": ""}], "filterCycleId": "65d397fc-b8b1-4e07-9437-026253db663a", "nextRunAt": "", "error": "", "averageTimeToGenerate": 0, "customSelection": [{"fieldName": "", "fieldDef": "", "fieldValues": [{"text": "", "number": ""}]}], "variables": [{"name": "", "value": ""}], "meta": {}, "dataPlatformWaitTime": 0, "email": "pdf", "groupsToShareWith": [{"groupId": "1392343e-c2b1-4e67-84b0-4afd219c57fe"}], "tags": [{"id": "1392343e-c2b1-4e67-84b0-4afd219c57fe", "name": ""}], "fieldInfo": {"fieldId": "", "fieldName": "", "fieldDef": ""}, "fieldValues": [{"name": "", "text": "", "number": 0}], "connectionId": "", "selectAll": true, "autotag": true}
{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "title": {"type": "string", "description": "Title of the report task", "maximum": 500}, "templateId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "startOn": {"type": "string", "description": "Datetime in UTC when report task's schedule will start", "format": "date-time", "maximum": 100}, "endOn": {"type": "string", "description": "Datetime in UTC when report task schedule will end", "format": "date-time", "maximum": 100}, "frequency": {"type": "string", "description": "Describes the frequency of the report task's schedule", "maximum": 100, "enum": ["Monthly", "Once - now", "Once - Scheduled", "Annually", "Daily", "Weekly"]}, "every": {"type": "string", "description": "The interval of the report task's schedule", "maximum": 100}, "at": {"type": "string", "description": "Datetime in UTC when the report task will execute", "format": "date-time", "maximum": 100}, "enabled": {"description": "Denotes whether the report task will go into the report processing queue", "type": "boolean"}, "filterSets": {"description": "Array of objects denoting filter sets to apply to the report task", "type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "title": {"type": "string"}}}}, "filterCycleId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "nextRunAt": {"type": "string", "description": "Calculated datetime in UTC when the report task will run next, if applicable", "format": "date-time", "maximum": 200}, "error": {"type": "string", "description": "The error object from the last report task execution, if applicable", "maximum": 200}, "averageTimeToGenerate": {"type": "number", "description": "The average time to run the report task, in minutes", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "customSelection": {"type": "array", "items": {"type": "object", "properties": {"fieldName": {"type": "string", "description": "The label of the field. Used for display in certain scenarios."}, "fieldDef": {"type": "string", "description": "The definition of the field."}, "fieldValues": {"type": "array", "items": {"type": "object", "properties": {"text": {"type": "string"}, "number": {"type": "string"}}}}}}, "description": "Custom filters to apply. This field will be updated entirely if provided"}, "variables": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "value": {"type": "string"}}}}, "meta": {"type": "object", "additionalProperties": {"type": "string"}}, "dataPlatformWaitTime": {"type": "number", "format": "double", "description": "The time spent waiting on data platform responses during the last report task execution, in minutes", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "email": {"type": "string", "description": "Denotes whether the generated report should be emailed to its users or groups after a successful run", "maximum": 100, "enum": ["pdf", "pptx", "xlsx", "csv"]}, "groupsToShareWith": {"description": "Groups to share the published report with. This field will be updated entirely if provided", "type": "array", "items": {"type": "object", "properties": {"groupId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}}}}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "name": {"type": "string"}}}}}}, {"type": "object", "properties": {"fieldInfo": {"type": "object", "properties": {"fieldId": {"type": "string"}, "fieldName": {"type": "string"}, "fieldDef": {"type": "string"}}}, "fieldValues": {"description": "This field will be updated entirely if provided and will result in removing any existing report tasks associated with the filter cycle.", "type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "text": {"type": "string"}, "number": {"type": "number"}}}}, "connectionId": {"type": "string"}, "selectAll": {"type": "boolean"}, "autotag": {"type": "boolean"}}}]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/0355504a-6475-4340-9363-55b7274f814b/3/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
createFilterCycle
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/576314f3-97e3-48f2-8cc6-4e7456e28820/0/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
renderTemplate
Render a report template to PDF, PPTX, or XLSX. Responds with a job entity.
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/576314f3-97e3-48f2-8cc6-4e7456e28820/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
renderTemplate
Render a report template to PDF, PPTX, or XLSX. Responds with a job entity.
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/576314f3-97e3-48f2-8cc6-4e7456e28820/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
renderTemplate
Render a report template to PDF, PPTX, or XLSX. Responds with a job entity.
200
null
{"jobId": "65d397fc-b8b1-4e07-9437-026253db663a", "data": {}, "status": "", "error": "", "userId": "65d397fc-b8b1-4e07-9437-026253db663a"}
{"type": "object", "properties": {"jobId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "data": {"type": "object"}, "status": {"type": "string"}, "error": {"type": "string"}, "userId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}}}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/576314f3-97e3-48f2-8cc6-4e7456e28820/3/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
renderTemplate
Render a report template to PDF, PPTX, or XLSX. Responds with a job entity.
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/0e722d12-5882-4316-8059-8aaa304950a5/0/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
updateReportTask
Accepts partial updates
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/0e722d12-5882-4316-8059-8aaa304950a5/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
updateReportTask
Accepts partial updates
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/0e722d12-5882-4316-8059-8aaa304950a5/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
updateReportTask
Accepts partial updates
200
null
{"id": "65d397fc-b8b1-4e07-9437-026253db663a", "title": "", "templateId": "1392343e-c2b1-4e67-84b0-4afd219c57fe", "startOn": "", "endOn": "", "frequency": "Monthly", "every": "", "at": "", "enabled": true, "filterSets": [{"id": "", "title": ""}], "filterCycleId": "65d397fc-b8b1-4e07-9437-026253db663a", "nextRunAt": "", "error": "", "averageTimeToGenerate": 0, "customSelection": [{"fieldName": "", "fieldDef": "", "fieldValues": [{"text": "", "number": ""}]}], "variables": [{"name": "", "value": ""}], "meta": {}, "dataPlatformWaitTime": 0, "email": "pdf", "groupsToShareWith": [{"groupId": "1392343e-c2b1-4e67-84b0-4afd219c57fe"}], "tags": [{"id": "1392343e-c2b1-4e67-84b0-4afd219c57fe", "name": ""}], "usersToShareWith": [{"userId": "1392343e-c2b1-4e67-84b0-4afd219c57fe", "email": "[email protected]"}]}
{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "title": {"type": "string", "description": "Title of the report task", "maximum": 500}, "templateId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "startOn": {"type": "string", "description": "Datetime in UTC when report task's schedule will start", "format": "date-time", "maximum": 100}, "endOn": {"type": "string", "description": "Datetime in UTC when report task schedule will end", "format": "date-time", "maximum": 100}, "frequency": {"type": "string", "description": "Describes the frequency of the report task's schedule", "maximum": 100, "enum": ["Monthly", "Once - now", "Once - Scheduled", "Annually", "Daily", "Weekly"]}, "every": {"type": "string", "description": "The interval of the report task's schedule", "maximum": 100}, "at": {"type": "string", "description": "Datetime in UTC when the report task will execute", "format": "date-time", "maximum": 100}, "enabled": {"description": "Denotes whether the report task will go into the report processing queue", "type": "boolean"}, "filterSets": {"description": "Array of objects denoting filter sets to apply to the report task", "type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "title": {"type": "string"}}}}, "filterCycleId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "nextRunAt": {"type": "string", "description": "Calculated datetime in UTC when the report task will run next, if applicable", "format": "date-time", "maximum": 200}, "error": {"type": "string", "description": "The error object from the last report task execution, if applicable", "maximum": 200}, "averageTimeToGenerate": {"type": "number", "description": "The average time to run the report task, in minutes", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "customSelection": {"type": "array", "items": {"type": "object", "properties": {"fieldName": {"type": "string", "description": "The label of the field. Used for display in certain scenarios."}, "fieldDef": {"type": "string", "description": "The definition of the field."}, "fieldValues": {"type": "array", "items": {"type": "object", "properties": {"text": {"type": "string"}, "number": {"type": "string"}}}}}}, "description": "Custom filters to apply. This field will be updated entirely if provided"}, "variables": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "value": {"type": "string"}}}}, "meta": {"type": "object", "additionalProperties": {"type": "string"}}, "dataPlatformWaitTime": {"type": "number", "format": "double", "description": "The time spent waiting on data platform responses during the last report task execution, in minutes", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "email": {"type": "string", "description": "Denotes whether the generated report should be emailed to its users or groups after a successful run", "maximum": 100, "enum": ["pdf", "pptx", "xlsx", "csv"]}, "groupsToShareWith": {"description": "Groups to share the published report with. This field will be updated entirely if provided", "type": "array", "items": {"type": "object", "properties": {"groupId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}}}}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "name": {"type": "string"}}}}}}, {"type": "object", "properties": {"usersToShareWith": {"description": "Users to share the published report with. This field will be updated entirely if provided", "type": "array", "items": {"type": "object", "properties": {"userId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "email": {"type": "string"}}}}}}]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/0e722d12-5882-4316-8059-8aaa304950a5/3/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
updateReportTask
Accepts partial updates
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/062cc6a8-9fa1-4536-8cf7-c7e25ea24a49/0/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getReportTasks
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/062cc6a8-9fa1-4536-8cf7-c7e25ea24a49/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getReportTasks
200
null
{"reportTasks": [{"id": "65d397fc-b8b1-4e07-9437-026253db663a", "title": "", "templateId": "1392343e-c2b1-4e67-84b0-4afd219c57fe", "startOn": "", "endOn": "", "frequency": "Monthly", "every": "", "at": "", "enabled": true, "filterSets": [{"id": "", "title": ""}], "filterCycleId": "65d397fc-b8b1-4e07-9437-026253db663a", "nextRunAt": "", "error": "", "averageTimeToGenerate": 0, "customSelection": [{"fieldName": "", "fieldDef": "", "fieldValues": [{"text": "", "number": ""}]}], "variables": [{"name": "", "value": ""}], "meta": {}, "dataPlatformWaitTime": 0, "email": "pdf", "groupsToShareWith": [{"groupId": "1392343e-c2b1-4e67-84b0-4afd219c57fe"}], "tags": [{"id": "1392343e-c2b1-4e67-84b0-4afd219c57fe", "name": ""}], "usersToShareWith": [{"userId": "1392343e-c2b1-4e67-84b0-4afd219c57fe", "email": "[email protected]"}]}], "totalPages": 2}
{"type": "object", "properties": {"reportTasks": {"type": "array", "items": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "title": {"type": "string", "description": "Title of the report task", "maximum": 500}, "templateId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "startOn": {"type": "string", "description": "Datetime in UTC when report task's schedule will start", "format": "date-time", "maximum": 100}, "endOn": {"type": "string", "description": "Datetime in UTC when report task schedule will end", "format": "date-time", "maximum": 100}, "frequency": {"type": "string", "description": "Describes the frequency of the report task's schedule", "maximum": 100, "enum": ["Monthly", "Once - now", "Once - Scheduled", "Annually", "Daily", "Weekly"]}, "every": {"type": "string", "description": "The interval of the report task's schedule", "maximum": 100}, "at": {"type": "string", "description": "Datetime in UTC when the report task will execute", "format": "date-time", "maximum": 100}, "enabled": {"description": "Denotes whether the report task will go into the report processing queue", "type": "boolean"}, "filterSets": {"description": "Array of objects denoting filter sets to apply to the report task", "type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "title": {"type": "string"}}}}, "filterCycleId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "nextRunAt": {"type": "string", "description": "Calculated datetime in UTC when the report task will run next, if applicable", "format": "date-time", "maximum": 200}, "error": {"type": "string", "description": "The error object from the last report task execution, if applicable", "maximum": 200}, "averageTimeToGenerate": {"type": "number", "description": "The average time to run the report task, in minutes", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "customSelection": {"type": "array", "items": {"type": "object", "properties": {"fieldName": {"type": "string", "description": "The label of the field. Used for display in certain scenarios."}, "fieldDef": {"type": "string", "description": "The definition of the field."}, "fieldValues": {"type": "array", "items": {"type": "object", "properties": {"text": {"type": "string"}, "number": {"type": "string"}}}}}}, "description": "Custom filters to apply. This field will be updated entirely if provided"}, "variables": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "value": {"type": "string"}}}}, "meta": {"type": "object", "additionalProperties": {"type": "string"}}, "dataPlatformWaitTime": {"type": "number", "format": "double", "description": "The time spent waiting on data platform responses during the last report task execution, in minutes", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "email": {"type": "string", "description": "Denotes whether the generated report should be emailed to its users or groups after a successful run", "maximum": 100, "enum": ["pdf", "pptx", "xlsx", "csv"]}, "groupsToShareWith": {"description": "Groups to share the published report with. This field will be updated entirely if provided", "type": "array", "items": {"type": "object", "properties": {"groupId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}}}}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "name": {"type": "string"}}}}}}, {"type": "object", "properties": {"usersToShareWith": {"description": "Users to share the published report with. This field will be updated entirely if provided", "type": "array", "items": {"type": "object", "properties": {"userId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "email": {"type": "string"}}}}}}]}}, "totalPages": {"type": "integer"}}}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/062cc6a8-9fa1-4536-8cf7-c7e25ea24a49/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getReportTasks
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/062cc6a8-9fa1-4536-8cf7-c7e25ea24a49/3/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getReportTasks
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/1c3cadf2-ff96-456b-8489-8512b0504830/0/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getFilterCycle
200
null
{"id": "65d397fc-b8b1-4e07-9437-026253db663a", "title": "", "templateId": "1392343e-c2b1-4e67-84b0-4afd219c57fe", "startOn": "", "endOn": "", "frequency": "Monthly", "every": "", "at": "", "enabled": true, "filterSets": [{"id": "", "title": ""}], "filterCycleId": "65d397fc-b8b1-4e07-9437-026253db663a", "nextRunAt": "", "error": "", "averageTimeToGenerate": 0, "customSelection": [{"fieldName": "", "fieldDef": "", "fieldValues": [{"text": "", "number": ""}]}], "variables": [{"name": "", "value": ""}], "meta": {}, "dataPlatformWaitTime": 0, "email": "pdf", "groupsToShareWith": [{"groupId": "1392343e-c2b1-4e67-84b0-4afd219c57fe"}], "tags": [{"id": "1392343e-c2b1-4e67-84b0-4afd219c57fe", "name": ""}], "fieldInfo": {"fieldId": "", "fieldName": "", "fieldDef": ""}, "fieldValues": [{"name": "", "text": "", "number": 0}], "connectionId": "", "selectAll": true, "autotag": true}
{"allOf": [{"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "title": {"type": "string", "description": "Title of the report task", "maximum": 500}, "templateId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "startOn": {"type": "string", "description": "Datetime in UTC when report task's schedule will start", "format": "date-time", "maximum": 100}, "endOn": {"type": "string", "description": "Datetime in UTC when report task schedule will end", "format": "date-time", "maximum": 100}, "frequency": {"type": "string", "description": "Describes the frequency of the report task's schedule", "maximum": 100, "enum": ["Monthly", "Once - now", "Once - Scheduled", "Annually", "Daily", "Weekly"]}, "every": {"type": "string", "description": "The interval of the report task's schedule", "maximum": 100}, "at": {"type": "string", "description": "Datetime in UTC when the report task will execute", "format": "date-time", "maximum": 100}, "enabled": {"description": "Denotes whether the report task will go into the report processing queue", "type": "boolean"}, "filterSets": {"description": "Array of objects denoting filter sets to apply to the report task", "type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "title": {"type": "string"}}}}, "filterCycleId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "nextRunAt": {"type": "string", "description": "Calculated datetime in UTC when the report task will run next, if applicable", "format": "date-time", "maximum": 200}, "error": {"type": "string", "description": "The error object from the last report task execution, if applicable", "maximum": 200}, "averageTimeToGenerate": {"type": "number", "description": "The average time to run the report task, in minutes", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "customSelection": {"type": "array", "items": {"type": "object", "properties": {"fieldName": {"type": "string", "description": "The label of the field. Used for display in certain scenarios."}, "fieldDef": {"type": "string", "description": "The definition of the field."}, "fieldValues": {"type": "array", "items": {"type": "object", "properties": {"text": {"type": "string"}, "number": {"type": "string"}}}}}}, "description": "Custom filters to apply. This field will be updated entirely if provided"}, "variables": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "value": {"type": "string"}}}}, "meta": {"type": "object", "additionalProperties": {"type": "string"}}, "dataPlatformWaitTime": {"type": "number", "format": "double", "description": "The time spent waiting on data platform responses during the last report task execution, in minutes", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308}, "email": {"type": "string", "description": "Denotes whether the generated report should be emailed to its users or groups after a successful run", "maximum": 100, "enum": ["pdf", "pptx", "xlsx", "csv"]}, "groupsToShareWith": {"description": "Groups to share the published report with. This field will be updated entirely if provided", "type": "array", "items": {"type": "object", "properties": {"groupId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}}}}, "tags": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "name": {"type": "string"}}}}}}, {"type": "object", "properties": {"fieldInfo": {"type": "object", "properties": {"fieldId": {"type": "string"}, "fieldName": {"type": "string"}, "fieldDef": {"type": "string"}}}, "fieldValues": {"description": "This field will be updated entirely if provided and will result in removing any existing report tasks associated with the filter cycle.", "type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "text": {"type": "string"}, "number": {"type": "number"}}}}, "connectionId": {"type": "string"}, "selectAll": {"type": "boolean"}, "autotag": {"type": "boolean"}}}]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/1c3cadf2-ff96-456b-8489-8512b0504830/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getFilterCycle
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/1c3cadf2-ff96-456b-8489-8512b0504830/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getFilterCycle
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/1c3cadf2-ff96-456b-8489-8512b0504830/3/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getFilterCycle
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/d7e5c686-ae46-4be8-ac59-d5739d22619f/0/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
deleteReport
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/d7e5c686-ae46-4be8-ac59-d5739d22619f/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
deleteReport
204
null
{"reportId": "65d397fc-b8b1-4e07-9437-026253db663a", "id": "65d397fc-b8b1-4e07-9437-026253db663a", "createdAt": "", "title": "", "authorId": "65d397fc-b8b1-4e07-9437-026253db663a", "firstName": "", "lastName": "", "thumbnailPath": ""}
{"type": "object", "properties": {"reportId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "id": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "createdAt": {"type": "string", "description": "Datetime in UTC when the report was published", "format": "date-time", "maximum": 100}, "title": {"type": "string", "description": "Title of the report task", "maximum": 500}, "authorId": {"type": "string", "pattern": "[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-4[0-9A-Za-z]{3}-[89ABab][0-9A-Za-z]{3}-[0-9A-Za-z]{12}"}, "firstName": {"type": "string", "description": "The given name of the author of the report"}, "lastName": {"type": "string", "description": "The surname of the author of the report"}, "thumbnailPath": {"type": "string", "description": "The relative path to the thumbnail of the report"}}}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/d7e5c686-ae46-4be8-ac59-d5739d22619f/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
deleteReport
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/d7e5c686-ae46-4be8-ac59-d5739d22619f/3/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
deleteReport
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/f246d67a-3ad6-413c-affd-9f838179444a/0/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getDocument
404
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/f246d67a-3ad6-413c-affd-9f838179444a/1/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getDocument
403
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}
3666bb60-13ca-40c4-8ec9-3a8f25ddf538/f246d67a-3ad6-413c-affd-9f838179444a/2/0
ConnectReport Core
Automatically generate scheduled and on-demand PDFs, Excel spreadsheets, PowerPoints, and other reports on your data.
null
getDocument
401
null
{"code": "", "message": ""}
{"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}, "required": ["message"]}