List Report Exports

The exports method is used to a list of available exports An export represents one version of a generated report. for a specific report The report contains all the dimensions and metrics information that you need to see.. It uses the OrganizationId for the specific organization In Broadsign Ads, an Organization is a client account that contains one or several users. and the reportId of the specific report for which you want a list of exports.

This will return a list of available exports for this report.

https://api.buy.broadsign.com/v1/organizations/{organizationId}/reports/{reportId}/exports

GET

Authorization: [my token]

Response Body Parameters

Parameter Description Type
id Unique identification number for the export. integer
generatedOn Date and time at which the export has been generated. date-time
status

Current status of the export. Available values are:

  • Processing
  • Done
  • Failed
 string

Response Body Example

Copy 
[
  {
    id: 568,
    generatedOn: "2022-09-22T21:13:01.930031+00:00",
    status: "Processing"
  },
  {
    id: 567,
    generatedOn: "2022-09-21T21:13:01.930031+00:00",
    status: "Done"
  },
  {
    id: 564,
    generatedOn: "2022-09-20T21:13:01.930031+00:00",
    status: "Failed"
  },
]
Copy 
"/organizations/{organizationId}/reports/{reportId}/exports" : {
      "get" : {
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "reportId",
          "in" : "path",
          "required" : true,
          "type" : "string"
        }, {
          "name" : "Authorization",
          "in" : "header",
          "required" : true,
          "type" : "string"
        }, {
          "name" : "organizationId",
          "in" : "path",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "200 response",
            "schema" : {
              "$ref" : "#/definitions/ExportsResponse"
            }
          },
          "401" : {
            "description" : "401 response"
          }
        },
        "security" : [ {
          "PublicApiLambdaAuthorizer" : [ ]
        }, {
          "api_key" : [ ]
        } ]
      }
    }
    
{
  "exports": [
  {
    id: 568,
    generatedOn: "2022-09-22T21:13:01.930031+00:00",
    status: "Processing"
  },
  {
    id: 567,
    generatedOn: "2022-09-21T21:13:01.930031+00:00",
    status: "Done"
  },
  {
    id: 564,
    generatedOn: "2022-09-20T21:13:01.930031+00:00",
    status: "Failed"
  },
]
}