List Reports

The reports method is used to fetch your list of reports 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. for which you want to fetch reports.

This will return a list of reports available for your organization.

Note: The status value in the response for report must be "Done", or you will not be bale to fetch available exports An export represents one version of a generated report..

https://api.buy.broadsign.com/v1/organizations/{id}/reports

GET

Authorization: [my token]

Response Body Parameters

Parameter Description Type
id Unique identification number for the report. int
name Name of the report. string
latestExport:id ID for that specific export. integer
latestExport:generatedOn Date and time at which the latest export has been generated. date-time
latestExport:status

Status of the latest export. Available values are:

  • Processing
  • Done
  • Failed
 string

Response Body Example

Copy 
[
  {
    id: 1001,
    name: "weekly impressions",
    latestExport: null
  },
  {
    id: 1002,
    name: "daily media cost",
    latestExport: {
      id: 567,
      generatedOn: "2022-09-21T21:13:01.930031+00:00",
      status: "Done"
  },
]
Copy 
"/organizations/{organizationId}/reports" : {
      "get" : {
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "Authorization",
          "in" : "header",
          "required" : true,
          "type" : "string"
        }, {
          "name" : "organizationId",
          "in" : "path",
          "required" : true,
          "type" : "string"
        } ],
        "responses" : {
          "200" : {
            "description" : "200 response",
            "schema" : {
              "$ref" : "#/definitions/ReportsResponse"
            }
          },
          "401" : {
            "description" : "401 response"
          }
        },
        "security" : [ {
          "PublicApiLambdaAuthorizer" : [ ]
        }, {
          "api_key" : [ ]
        } ]
      }
    }
    
{
  "reports" : [
  {
    id: 1001,
    name: "weekly impressions",
    latestExport: null
  },
  {
    id: 1002,
    name: "daily media cost",
    latestExport: {
      id: 567,
      generatedOn: "2022-09-21T21:13:01.930031+00:00",
      status: "Done"
  },
]
}