---
updatedAt: 2026-04-23T12:53:11.000Z
agentTools:
  projectIndex: https://developers.themarketer.com/llms.txt
---

# Popup Reports

The Get Forms Popups endpoint in the Reporting API allows you to get detailed insights regarding your subscription popups created through theMarketer.

The list of available popups metrics is defined in the sample call in the "type" parameter.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "theMarketer API",
    "version": "1.0.0",
    "description": ""
  },
  "servers": [
    {
      "url": "https://t.themarketer.com"
    }
  ],
  "paths": {
    "/api/v1/reports/get-forms-popups": {
      "parameters": [],
      "get": {
        "summary": "Popup Reports",
        "tags": [],
        "parameters": [
          {
            "name": "k",
            "in": "query",
            "required": true,
            "deprecated": false,
            "schema": {
              "type": "string"
            },
            "example": "REST_KEY"
          },
          {
            "name": "u",
            "in": "query",
            "required": true,
            "deprecated": false,
            "schema": {
              "type": "string"
            },
            "example": "CUSTOMER_ID"
          },
          {
            "name": "type",
            "in": "query",
            "required": true,
            "deprecated": false,
            "schema": {
              "type": "string",
              "enum": [
                "total-impressions",
                "total-subscribed-users",
                "total-subscribe-rate",
                "impressions",
                "subscribed-users",
                "subscribe-rate"
              ]
            },
            "example": "total-impressions"
          },
          {
            "name": "start",
            "in": "query",
            "required": true,
            "deprecated": false,
            "schema": {
              "type": "string",
              "format": "date"
            },
            "example": "2025-04-01"
          },
          {
            "name": "end",
            "in": "query",
            "required": true,
            "deprecated": false,
            "schema": {
              "type": "string",
              "format": "date"
            },
            "example": "2025-04-30"
          },
          {
            "name": "previous_start",
            "in": "query",
            "required": false,
            "deprecated": false,
            "schema": {
              "type": "string",
              "format": "date"
            },
            "example": "2024-03-01"
          },
          {
            "name": "previous_end",
            "in": "query",
            "required": false,
            "deprecated": false,
            "schema": {
              "type": "string",
              "format": "date"
            },
            "example": "2024-03-30"
          }
        ],
        "responses": {
          "200": {
            "description": "200 Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "period": {
                      "type": "object",
                      "properties": {
                        "2025-06-01": {
                          "type": "integer",
                          "example": "120000",
                          "description": "120000"
                        },
                        "2025-06-02": {
                          "type": "integer",
                          "example": "80000",
                          "description": "80000"
                        }
                      }
                    },
                    "previousPeriod": {
                      "type": "object",
                      "properties": {
                        "2025-05-01": {
                          "type": "integer",
                          "example": "65000",
                          "description": "65000"
                        },
                        "2025-05-02": {
                          "type": "integer",
                          "example": "78000",
                          "description": "78000"
                        }
                      }
                    },
                    "total_period": {
                      "type": "integer",
                      "example": "200000",
                      "description": "200000"
                    },
                    "campaigns": {
                      "type": "object",
                      "properties": {
                        "names": {
                          "type": "object",
                          "properties": {
                            "251": {
                              "type": "string",
                              "example": "Campaign 1 subject line",
                              "description": "Campaign 1 subject line"
                            },
                            "256": {
                              "type": "string",
                              "example": "Campaign 2 subject line",
                              "description": "Campaign 2 subject line"
                            }
                          }
                        },
                        "data": {
                          "type": "object",
                          "properties": {
                            "251": {
                              "type": "integer",
                              "example": "120000",
                              "description": "120000"
                            },
                            "256": {
                              "type": "integer",
                              "example": "80000",
                              "description": "80000"
                            }
                          }
                        }
                      }
                    },
                    "total_previous_period": {
                      "type": "integer",
                      "example": "143000",
                      "description": "143000"
                    },
                    "evolution": {
                      "type": "number",
                      "example": "-10.5",
                      "description": "-10.5"
                    }
                  }
                },
                "example": {
                  "period": {
                    "2025-04-01": 0,
                    "2025-04-02": 45,
                    "2025-04-03": 0,
                    "2025-04-04": 48,
                    "2025-04-05": 0,
                    "2025-04-06": 0,
                    "2025-04-07": 0,
                    "2025-04-08": 51,
                    "2025-04-09": 52,
                    "2025-04-10": 55,
                    "2025-04-11": 0,
                    "2025-04-12": 3,
                    "2025-04-13": 0,
                    "2025-04-14": 0,
                    "2025-04-15": 58,
                    "2025-04-16": 0,
                    "2025-04-17": 0,
                    "2025-04-18": 0,
                    "2025-04-19": 0,
                    "2025-04-20": 0,
                    "2025-04-21": 0,
                    "2025-04-22": 0,
                    "2025-04-23": 61,
                    "2025-04-24": 65,
                    "2025-04-25": 67,
                    "2025-04-26": 8,
                    "2025-04-27": 0,
                    "2025-04-28": 73,
                    "2025-04-29": 65,
                    "2025-04-30": 10
                  },
                  "previousPeriod": {
                    "2024-03-01": 0,
                    "2024-03-02": 0,
                    "2024-03-03": 0,
                    "2024-03-04": 0,
                    "2024-03-05": 0,
                    "2024-03-06": 0,
                    "2024-03-07": 0,
                    "2024-03-08": 0,
                    "2024-03-09": 0,
                    "2024-03-10": 0,
                    "2024-03-11": 0,
                    "2024-03-12": 0,
                    "2024-03-13": 0,
                    "2024-03-14": 0,
                    "2024-03-15": 0,
                    "2024-03-16": 0,
                    "2024-03-17": 0,
                    "2024-03-18": 0,
                    "2024-03-19": 0,
                    "2024-03-20": 0,
                    "2024-03-21": 0,
                    "2024-03-22": 0,
                    "2024-03-23": 0,
                    "2024-03-24": 0,
                    "2024-03-25": 0,
                    "2024-03-26": 0,
                    "2024-03-27": 0,
                    "2024-03-28": 0,
                    "2024-03-29": 0,
                    "2024-03-30": 0
                  },
                  "total_period": 661,
                  "campaigns": {
                    "names": [],
                    "data": {
                      "67e27f4fd61c527b6e061763": 607,
                      "67f4f5ff5a4a4a1e610e644a": 54
                    }
                  },
                  "total_previous_period": 0,
                  "evolution": 0
                }
              }
            }
          },
          "400": {
            "description": "400 Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Customer ID not provided / REST Key not provided",
                      "description": "Customer ID not provided / REST Key not provided"
                    }
                  }
                },
                "example": {
                  "message": "Customer ID not provided."
                }
              }
            }
          },
          "401": {
            "description": "401 Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Invalid REST Key",
                      "description": "Invalid REST Key"
                    }
                  }
                },
                "example": {
                  "message": "Invalid REST Key."
                }
              }
            }
          },
          "404": {
            "description": "404 Not found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Customer not found",
                      "description": "Customer not found"
                    }
                  }
                },
                "example": {
                  "message": "No query results for model [App\\Models\\System\\Domain] CUSTOMER_ID"
                }
              }
            }
          },
          "405": {
            "description": "405 Method not allowed",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "The POST method is not supported for this route. Supported methods: GET, HEAD.",
                      "description": "The POST method is not supported for this route. Supported methods: GET, HEAD."
                    }
                  }
                },
                "example": {
                  "message": "The POST method is not supported for this route. Supported methods: GET, HEAD."
                }
              }
            }
          }
        }
      }
    }
  }
}
```