demandbase/collections/demandbase-data-export.opencollection.json at main · api-evangelist/demandbase · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
{
  "opencollection": "1.0.0",
  "info": {
    "name": "Demandbase Data Export API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Export Jobs",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Demandbase List export jobs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.demandbase.com/export/v1/jobs",
            "params": [
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter by job status"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieve a list of data export jobs with their current status and metadata."
        },
        {
          "info": {
            "name": "Demandbase Create an export job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.demandbase.com/export/v1/jobs",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new asynchronous data export job. Specify the entity type, fields to export, filters, and date range. Exported data is delivered as downloadable CSV files."
        },
        {
          "info": {
            "name": "Demandbase Get export job status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.demandbase.com/export/v1/jobs/:jobId",
            "params": [
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "Export job unique identifier"
              }
            ]
          },
          "docs": "Retrieve the current status and details of a specific export job, including progress information and download URLs when complete."
        },
        {
          "info": {
            "name": "Demandbase Cancel an export job",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.demandbase.com/export/v1/jobs/:jobId",
            "params": [
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "Export job unique identifier"
              }
            ]
          },
          "docs": "Cancel a pending or processing export job."
        },
        {
          "info": {
            "name": "Demandbase List exportable entities",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.demandbase.com/export/v1/entities"
          },
          "docs": "Retrieve the list of entity types available for export and their supported fields."
        }
      ]
    },
    {
      "info": {
        "name": "Downloads",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Demandbase Download export file",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.demandbase.com/export/v1/jobs/:jobId/download",
            "params": [
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "Export job unique identifier"
              },
              {
                "name": "part",
                "value": "",
                "type": "query",
                "description": "Part number for multi-part exports (starts at 1)"
              }
            ]
          },
          "docs": "Download the exported CSV file for a completed export job. Returns a redirect to a pre-signed download URL."
        }
      ]
    }
  ],
  "bundled": true
}