> For the complete documentation index, see [llms.txt](https://help.adgebra.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.adgebra.co/getting-started/publish-your-docs-11/partner-report-api.md).

# Partner Report API

The Adgebra Report API integration guidelines will be able to fetch numbers from adgebra reports in real-time by sending the required parameters in an API call. In response, adgebra will send data as per the below-mentioned format.

### API Format 

{% stepper %}
{% step %}
**Request Format**

{% code overflow="wrap" %}

```
https://adgebra.co.in/pssreport/GetPSSReportWS?p1=[PartnerID]&p2=[Date]&p3=[SiteName]&p4=[Uniwque-Pin]&p7=[Geo]&p8=[Currency]
```

{% endcode %}

**`Request Parameters`** 

<pre data-overflow="wrap"><code><strong>p1=Partner Id of which the reports need to be fetched ex:'432'.
</strong>
p2: This Parameter is the date of the report that needs to be fetched. The Date format for this field is "DD-MMM-YYYY" Ex: 01-Nov-2023

p3: This parameter represents the site name. The default is 'all'. If you need data on any particular site you can enter the site name in p3 parameter.

p4: This Parameter is the unique pin associated with the partner. Here you need to contact your partner manager to get the unique pin. Ex : z8Sgxc82Mnxrb9me

p7: This Parameter is the Geo field. The default is 'All'. Hence your report will be shown for all geos. Removing this parameter will run your reports by site instead of geo.

p8: This parameter is the currency format that you wish to fetch in the report. The default is 'USD'. You cannot change it to any other currency at this time.
</code></pre>

**Request Example:**

{% code overflow="wrap" %}

```
https://adgebra.co.in/pssreport/GetPSSReportWS?p1=490&p2=02-Nov-2023&p3=all&p4=z8Sgxc82Mnxrb9r3&p7=all&p8=usd
```

{% endcode %}

{% endstep %}

{% step %}
**Response Format**

```
{
  "Site_Device": [
    {
      "Geo": "[Country]",
      "CTR": "[Count]",
      "Rev": "[Count]",
      "Impression": "[Count]",
      "Clicks": "[Count]"
    }
  ],
```

**Response Example:**

```
{
  prfd-sarkaryojana.in_Mobile": [
    {
      "Geo": "Bahrain",
      "CTR": "0.00",
      "Rev": "0.00",
      "Impression": "9",
      "Clicks": "0"
    },
    {
      "Geo": "India",
      "CTR": "0.21",
      "Rev": "2.65",
      "Impression": "176608",
      "Clicks": "364"
    },
    {
      "Geo": "Kuwait",
      "CTR": "0.00",
      "Rev": "0.00",
      "Impression": "109",
      "Clicks": "0"
    },
    {
      "Geo": "Oman",
      "CTR": "0.00",
      "Rev": "0.00",
      "Impression": "19",
      "Clicks": "0"
    },
    {
      "Geo": "United Arab Emirates",
      "CTR": "0.00",
      "Rev": "0.00",
      "Impression": "142",
      "Clicks": "0"
    },
    {
      "Geo": "Qatar",
      "CTR": "0.00",
      "Rev": "0.00",
      "Impression": "44",
      "Clicks": "0"
    }
  ],
  "prfd-biharhelp.in_Mobile": [
    {
      "Geo": "Pakistan",
      "CTR": "0.00",
      "Rev": "0.00",
      "Impression": "1",
      "Clicks": "0"
    },
    {
      "Geo": "India",
      "CTR": "0.13",
      "Rev": "4.91",
      "Impression": "496712",
      "Clicks": "643"
    },
}
```

{% endstep %}
{% endstepper %}

#### Note:

* At any point in time, if the response is blank or invalid, then it should be handled at the client's end. At times when planned/unplanned adgebra maintenance activity may be scheduled.
* If any reponse is blank, please check the values entered in the parameters. The response will also be blank in case there is no data.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.adgebra.co/getting-started/publish-your-docs-11/partner-report-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.