Skip to main content
GET
/
v2
/
reporting
/
campaign
/
{campaignUID}
Get a pdf report with mission information.
curl --request GET \
  --url https://client.synack.com/api/tasks/v2/reporting/campaign/{campaignUID}/ \
  --header 'Authorization: Bearer <token>'
{
  "campaignDetails": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "description": "<string>",
    "listingUid": "<string>",
    "assetTypes": [
      "<string>"
    ],
    "scope": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "completedOn": "2023-11-07T05:31:56Z",
    "publishedOn": "2023-11-07T05:31:56Z",
    "tasksTotal": 123,
    "tasksCompleted": 123,
    "tasksPassed": 123,
    "tasksFailed": 123
  },
  "tasks": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "definitionUID": "<string>",
      "definitionName": "<string>",
      "structuredResponse": "<string>",
      "assetTypes": [
        "<string>"
      ],
      "attackTypes": [
        "<string>"
      ],
      "attachments": [
        {
          "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "title": "<string>",
          "description": "<string>",
          "originalFilename": "<string>",
          "sizeInBytes": 123,
          "groupUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "createdOn": "2023-12-25",
          "modifiedOn": "2023-12-25",
          "createdBy": "<string>",
          "modifiedBy": "<string>",
          "version": 123,
          "data": "<string>",
          "thumbnailData": "<string>",
          "position": 123,
          "mimeType": "<string>"
        }
      ],
      "completedOn": "2023-11-07T05:31:56Z",
      "scope": "<string>",
      "status": "<string>",
      "type": "<string>",
      "categories": [
        "<string>"
      ],
      "response": "<string>",
      "controlFamily": "<string>",
      "fismaLow": "<string>",
      "fismaModerate": "<string>",
      "fismaHigh": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaignUID
string<uuid>
required

The campaign UID to generate the report for.

Query Parameters

category
string[]

syn_categories to search tasks

status
string[]

statuses to search tasks

structuredResponse
string

structured response to search tasks

q
string

free text to search missions by title

Response

Successful operation.

Response model used by the GET /reporting/campaign/{campaignUID} endpoint.

campaignDetails
object
tasks
object[]