Skip to content

Q3 analytics api examples #1079

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open

Q3 analytics api examples #1079

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
bab014f
Create analytics-api-examples.md
NimRegev Sep 26, 2024
d09f265
Update analytics-api-examples.md
NimRegev Sep 26, 2024
a71408b
Update analytics-api-examples.md
NimRegev Sep 26, 2024
e2cfbc0
Update analytics-api-examples.md
NimRegev Oct 1, 2024
1e2fc16
Update analytics-api-examples.md
NimRegev Oct 6, 2024
129faf5
Update nav.yml
NimRegev Oct 6, 2024
40d652d
Merge branch 'master' into q3-analytics-api-examples
NimRegev Oct 7, 2024
746c40a
Update analytics-api-examples.md
NimRegev Oct 8, 2024
4721a37
Merge branch 'q3-analytics-api-examples' of https://github.com/codefr…
NimRegev Oct 8, 2024
7da0219
Update analytics-api-examples.md
NimRegev Oct 8, 2024
e113fc2
Update analytics-api-examples.md
NimRegev Nov 18, 2024
30ed0c5
Add location of project id
NimRegev Nov 19, 2024
785902b
Update analytics-api-examples.md
NimRegev Nov 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update analytics-api-examples.md
  • Loading branch information
@NimRegev
NimRegev committed Sep 26, 2024
commit a71408bf45ad403b0ac17c5d1ba8448900baf7ce
317 changes: 12 additions & 305 deletions _docs/api-examples/analytics-api-examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,164 +30,34 @@ Currently, you do not need to select specific scopes for the API key.



## Get list of pipelines /pipelinesDropdown
## Get all pipelines/pipelines by name

Gets the list of pipelines - max number? what are the default settings?
by pipeline name or ID.
Retrieve all the pipelines in your account, or filter by a pipeline name or part of the name to retrieve a specific set of pipelines.
Filtering by a name retrieves those pipelines whose names match or contain the text in the filter string.


### Headers
The API authorization token must be included in the header of the API request. See [Authorization](#authorization).
The API authorization token must be included in the header of the GET request. See [Authorization](#authorization).

```
content-type: application/json
Authorization: <TOKEN>
```

### Request body

For a description of the fields, see [Request parameters](#request-parameters).



### Request example

The request is an HTTP GET request.

```
GET https://g.codefresh.io/api/analytics/reports/pipelinesDropdown
```
### Response example

#### Success
Here's an example of the response for a successful request.

For each pipeline, the following data is returned.
* `id`: The ID of the pipeline, generated when the pipeline was created.
* `pipelineName`: The full name of the pipeline, including the project name, in the format `"<project-name>/<pipeline-name>"`.
* `shortName`: The name of the pipeline, without the project name.
* `isDeleted`: Indicates if the pipeline has been deleted from the account (`true`), or not (`false`).

```json
{
"data": [
{
"id": "61a893f69ff69e2cf086f12d",
"pipelineName": "NimaCFProject/BasicPipeline",
"shortName": "basicpipeline",
"isDeleted": false
},
{
"id": "632afb121899584bf3ec14f8",
"pipelineName": "default/NimaCronLink",
"shortName": "nimacronlink",
"isDeleted": false
},
{
"id": "6372180f39b06e632745555d",
"pipelineName": "test",
"shortName": "test",
"isDeleted": false
},
{
"id": "639ede86ec4d257410904ba7",
"pipelineName": "NimaCFProject/StepTest",
"shortName": "steptest",
"isDeleted": false
},
{
"id": "63b58656e8dad136b2a74927",
"pipelineName": "my-first-project/My Pipeline",
"shortName": "my pipeline",
"isDeleted": false
},
{
"id": "641fe3c0ba826b3e53d3bbbd",
"pipelineName": "TestTags",
"shortName": "testtags",
"isDeleted": false
},
{
"id": "641fe485ba826b8fe8d3bbbe",
"pipelineName": "MyPipelines",
"shortName": "mypipelines",
"isDeleted": false
},
{
"id": "6423edc4dbc27269e2693bb6",
"pipelineName": "NimaCFProject/Restart",
"shortName": "restart",
"isDeleted": false
},
{
"id": "642578967afcb3664998231a",
"pipelineName": "AnnotatePipeline",
"shortName": "annotatepipeline",
"isDeleted": false
},
{
"id": "64cb4160795de76fcd8b5b29",
"pipelineName": "MyPipelines template",
"shortName": "mypipelines template",
"isDeleted": false
},
{
"id": "64cb42f2993fc4da530b8756",
"pipelineName": "mu",
"shortName": "mu",
"isDeleted": false
},

{
"id": "66f246ff58c8309825491a5a",
"pipelineName": "Marvel/smoke-tests",
"shortName": "smoke-tests",
"isDeleted": false
}
]
},

"timeDimensions": {}
```
### Endpoint

#### Failure
Here's an example of the
`GET https://g.codefresh.io/api/analytics/reports/pipelinesDropdown&filters={"name":["pipeline_name"]}`

```
{"statusCode":400,"message":"no changes found between source and destination applications","error":"Bad Request"}
```

## Get list of pipeline by name

Get the list of pipelines that correspond to the name passed as the query parameter.
You can either pass the complete name of the pipeline or a partial name. In which case, returns all pipelines including those characters.
by pipeline name or ID.
### Query parameters

`

### Headers
The API authorization token must be included in the header of the API request. See [Authorization](#authorization).

```
content-type: application/json
Authorization: <TOKEN>
```

### Request body

For a description of the fields, see [Request parameters](#request-parameters).



### Request example
{: .table .table-bordered .table-hover}
| Setting | Description | Data Type | Required/Optional
| `name` | The name of the pipeline or a part of the name by which to filter the pipelines. For example, ??? retrieves only pipelines that match the whole name. `e-to-e` retrieves all pipelines that include `e-to-e` in their names. | string | Optional |

The request is an HTTP GET request.

```
GET https://g.codefresh.io/api/analytics/reports/pipelinesDropdown/?filters={"name":["<pipeline-name>"]}
```
### Response example

#### Success
#### Reponse
Here's an example of the response for a successful request.

For each pipeline, the following data is returned.
Expand Down Expand Up @@ -288,171 +158,8 @@ Here's an example of the



## POST `/promotions/pullRequest`

Promotes the application from the source environment to the destination or target environment through a `pull request` as the promotion action.

### `pullRequest` request body

```
{
"srcAppId": {
"runtime": "<runtime name>",
"namespace": "<namespace>",
"name": "<source-application-name>"
},
"destAppId": {
"runtime": "<runtime-name>",
"namespace": "<namespace>",
"name": "<destination-application-name>"
},
"head": "<branch-of-destination-application>",
"title": "<pr-title>",
"description": "<pr-description",
"commitMessage": "<commit-message-when-empty-uses-title>",
"commitDescription": "<commit-description>",
}"
```

### `pullRequest` request example
The request is formatted in curl.

```
curl -X POST https://codefresh-hosted-gitops-runtime.com/api/promotions/pullRequest \
--header "content-type: application/json" \
--header "Authorization: 214ffb**************" \
--data "{
\"srcAppId\": {
\"runtime\": \"codefresh\",
\"namespace\": \"membership-staging\",
\"name\": \"membership-staging\"
},
\"destAppId\": {
\"runtime\": \"codefresh\",
\"namespace\": \"membership-prod\",
\"name\": \"membership-prod\"
},
\"head\": \"main\",
\"title\": \"Merge new-accounts\",
\"description\": \"Added new accounts and git sources\",
\"commitMessage\": \"Merge new-accounts\",
\"commitDescription\": \"Approved new accounts and git sources\",
}"

```
### `pullRequest` response example

#### Success
TBD


#### Failure
TBD



## Request query parameters

{: .table .table-bordered .table-hover}
| Parameter | Description |
| ---------- | -------- |
| `dateRange` | The time frame for which to send report data. This can be in the from-to format for a custom time frame, or a predefined fixed range.<br>For from-to date ranges, the format is `yyyy-mm-dd`. For example, `?dateRange=2024-04-30&dateRange=2023-08-01`. The from date must be earlier than the to date. <br>For fixed date ranges, use one of the following:<br>- `today`: Today's date.<br>- `Last 7 days`: <br>- `Last 30 days`: `dateRange=last%203%20month` (NIMA: need to find what are the fixed date ranges supported and how to add them?)|
| `filter` | |
| `granularity` | |


<table class="table table-bordered table-hover" style="width: 100%;">
<colgroup>
<col style="width: 10%;">
<col style="width: 70%;">
<col style="width: 10%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th style="width: 10%;">Parameter</th>
<th style="width: 70%;">Description</th>
<th style="width: 10%;">Data Type</th>
<th style="width: 10%;">Required/Optional</th>
</tr>
</thead>
<tbody>
<tr>
<td rowspan="4"><code class="highlighter-rouge">dateRange</code></td>
<td colspan="3">The application in the source environment to promote through the <code class="highlighter-rouge">runtime</code>, <code class="highlighter-rouge">namespace</code>, and <code class="highlighter-rouge">name</code> key-value pairs.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">srcAppId.runtime</code>: The name of the GitOps Runtime associated with the source application.</td>
<td>String</td>
<td>Required</td>
</tr>
<tr>
<td><code class="highlighter-rouge">srcAppId.namespace</code>: The namespace where the source application is deployed.</td>
<td>String</td>
<td>Required</td>
</tr>
<tr>
<td><code class="highlighter-rouge">srcAppId.name</code>: The name of the source application to be promoted.</td>
<td>String</td>
<td>Required</td>
</tr>
<tr>
<td rowspan="4"><code class="highlighter-rouge">destAppId</code></td>
<td colspan="3">The application in the destination environment to be promoted through the <code class="highlighter-rouge">runtime</code>, <code class="highlighter-rouge">namespace</code>, and <code class="highlighter-rouge">name</code> key-value pairs.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">destAppId.runtime</code>: The name of the GitOps Runtime associated with the application in the destination environment.</td>
<td>String</td>
<td>Required</td>
</tr>
<tr>
<td><code class="highlighter-rouge">destAppId.namespace</code>: The namespace in the destination environment where the application being promoted is deployed.</td>
<td>String</td>
<td>Required</td>
</tr>
<tr>
<td><code class="highlighter-rouge">destAppId.name</code>: The name of the application in the destination environment to be promoted.</td>
<td>String</td>
<td>Required</td>
</tr>
<tr>
<td><code class="highlighter-rouge">message</code></td>
<td>Applies to <code class="highlighter-rouge">commit</code> promotion actions.<br>The commit message to associate for the commit promotion action.(limits)</td>
<td>String</td>
<td>Required</td>
</tr>
<tr>
<td><code class="highlighter-rouge">head</code></td>
<td>Applies to <code class="highlighter-rouge">pull request</code> promotion actions.<br>The branch of the application in the destination environment on which to open the PR.</td>
<td>String</td>
<td>Required</td>
</tr>
<tr>
<td><code class="highlighter-rouge">title</code></td>
<td>Applies to <code class="highlighter-rouge">pull request</code> promotion actions.<br>The title of the pull request.</td>
<td>String</td>
<td>Required</td>
</tr>
<tr>
<td><code class="highlighter-rouge">description</code></td>
<td>Applies to <code class="highlighter-rouge">pull request</code> promotion actions.<br>Additional information describing the pull request.</td>
<td>String</td>
<td>Optional</td>
</tr>
<tr>
<td><code class="highlighter-rouge">commitMessage</code></td>
<td>Applies to <code class="highlighter-rouge">pull request</code> promotion actions.<br>The commit message when the pull request is approved.<br>If omitted, uses <code class="highlighter-rouge">title</code> instead. </td>
<td>String</td>
<td>Optional</td>
</tr>
<tr>
<td><code class="highlighter-rouge">commitDescription</code></td>
<td>Applies to <code class="highlighter-rouge">pull request</code> promotion actions.<br>Additional information on the commit message when the pull request is approved. </td>
<td>String</td>
<td>Optional</td>
</tr>
</tbody>
</table>



Expand Down